菜单
Quality validation checklist for generated documentation pages. Covers content completeness, evidence backing, markdown syntax, diagram validation, and cross-reference consistency. Use before finalizing any documentation page.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Comprehensive codebase analysis framework covering 14 technical areas including system overview, architecture, modules, integrations, workflows, and deployment patterns. Use when analyzing a codebase structure for documentation or understanding.
Output templates and response formats for documentation page generation. Defines JSON response structure, metadata schema, and error handling templates. Use when generating documentation pages and returning status.
Documentation structure heuristics and sitemap patterns for different codebase types and team sizes. Covers horizontal (concern-based), vertical (domain-based), and hybrid patterns. Use when planning documentation organization.
Evidence-backed documentation patterns with source code citations. Provides guidelines for citing source files, line numbers, and code examples in technical documentation. Use when writing documentation that needs to reference actual code.
ASCII diagram generation skill for creating professional architectural diagrams in text format. Supports C4 models, sequence diagrams, component diagrams, deployment diagrams, data flow diagrams, class diagrams, and integration diagrams for technical documentation.
Output templates and formatting rules for documentation structure files. Defines the four-section format (Proposed Root, Sitemap, Page Plan, Navigation Rules), front matter schema, and confirmation messages. Use when generating documentation structure output.
| name | documentation-quality-checklist |
| description | Quality validation checklist for generated documentation pages. Covers content completeness, evidence backing, markdown syntax, diagram validation, and cross-reference consistency. Use before finalizing any documentation page. |
| user-invocable | false |
Validation criteria for generated documentation pages. Run through this checklist before writing any page to disk.
[text](../../path/to/page.md)| Page Type | Target Range | Notes |
|---|---|---|
| Overview pages | 500-1000 | Concise, high-level |
| Architecture pages | 1000-2000 | Detailed with diagrams |
| Component/service pages | 800-1500 | Focused on single topic |
| Workflow pages | 600-1200 | Step-by-step with diagrams |
| Reference pages | 300-800 | Tables and lists |
For rapid checks, verify these critical items:
A page should NOT be written if:
Version: 1.0 Last Updated: 2026-01-22