Review documentation pages for structure, readability, and consistency before release.
npx skills add https://github.com/Pionpill/retikz --skill docs-doc-review
Please help me install this Agent Skill. Skill: docs-doc-review Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/docs-doc-review Command: npx skills add https://github.com/Pionpill/retikz --skill docs-doc-review
这项 Skill 帮你在文档写作完成后，从初级前端工程师的阅读体验出发做独立审稿，定位页面结构是否符合页型规范、双语是否对齐、demo/图示是否足够以及专业术语是否过载等问题，避免作者自嗨式内容影响读者理解。
让你的 AI 依据给定的目标页面路径和 git diff，对 apps/docs/src/contents/**/index.zh.mdx 进行独立审稿，只输出问题清单与修改建议，不直接改稿。
High-intent search queries and answers about installing and using this skill.
Reviewing bilingual documentation for zh/en alignment involves verifying page-type layouts, matching table and example quantities across language versions, and ensuring synchronized contents, data, and i18n updates. This catches structural deviations and missing translations before release.
Checking documentation demo and diagram coverage requires verifying that examples actually demonstrate feature differences and include necessary minimal examples with visual cues. This ensures TikZ and D3 comparisons are centralized in reference sections rather than scattered within main text.
Auditing documentation readability from a frontend engineer's perspective means evaluating whether pages immediately answer what problem is solved and when to use the feature. It checks if technical terms need earlier plain explanations and if API tables can be understood independently.
Yes, you can use an automated review process to audit existing apps/docs pages by supplying the target page path and git diff. The review then independently analyzes the changes and outputs a problem list with modification suggestions without directly altering the manuscript.
You should run a documentation consistency check after writing is complete but before release. This timing allows you to catch page-type structural issues, zh/en misalignment, and insufficient demo coverage while corrections can still be applied to the source mdx files.
A documentation review report shows mismatched contents and i18n data when synchronization checks detect that updated page content was not propagated across all three directories. This indicates a maintenance gap where Related links and data files need manual syncing.
skaile-aiWrite, update, audit, and status documentation across five Skaile Dev doc surfaces.
vercelList npm package tarball contents before publishing.
furiosa-aiDiscover documentation sources, define structures, and save requirements to docs/doc-requirements.md.
TheBushidoCollectiveAutomates Markdown table creation, formatting, and validation for documentation and READMEs.
