docs-doc-review
Community独立审稿,提升文档可读性与规范性。
Content & Communication#documentation review#docs consistency#bilingual alignment#frontend reader experience#demo coverage#TikZ reference
AuthorPionpill
Version1.0.0
Installs0
System Documentation
What problem does it solve?
这项 Skill 帮你在文档写作完成后,从初级前端工程师的阅读体验出发做独立审稿,定位页面结构是否符合页型规范、双语是否对齐、demo/图示是否足够以及专业术语是否过载等问题,避免作者自嗨式内容影响读者理解。
Core Features & Use Cases
- 页型结构与一致性检查:组件页/示例页/分组页/Reference 页按既定结构核对,重点检查 zh/en 层级、表格与示例数量对齐。
- 读者视角可读性评审:判断开头是否先回答“解决什么问题/什么时候用”、专业词是否需要更前置的通俗解释,以及 API 表是否能独立读懂。
- 对照与 demo 覆盖核查:核对 TikZ/D3 等对照是否集中放到 Comparison / reference(而不是正文散落),检查 demo 是否真实展示差异、是否缺少必要最小示例与图示线索。
- 双语与三处协同可维护性:验证 contents/ data/ i18n 相关内容是否同步,以及 Related 链接是否指向更合适的下一页。
Quick Start
让你的 AI 依据给定的目标页面路径和 git diff,对 apps/docs/src/contents/**/index.zh.mdx 进行独立审稿,只输出问题清单与修改建议,不直接改稿。
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-doc-review Download link: https://github.com/Pionpill/retikz/archive/main.zip#docs-doc-review Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.