documentation-specialist

Documentation Specialist Skill

Capabilities

• Documentation Retrieval: Quickly find and summarize design documents, specification documents, and plan documents located under the docs/ directory.
• Documentation Generation: Automatically update or create new Markdown documents based on code changes.
• Specification Check: Ensure documentation follows the project's documentation structure and style guide (as defined in AGENTS.md and docs/standards/documentation.md ).
• Plan Management: Able to read docs/plan/todo.md and docs/plan/roadmap.md to understand the current task status, and read docs/plan/todo-archive.md to understand archived task status.
• Portal Maintenance: Responsible for updating the README.mdin the root directory, ensuring it stays in sync with project features and status.
• Process Alignment: When release or Review Gate instructions are involved, prioritize aligning with the actual behavior of scripts/release/pre-release-check.mjs and scripts/review-gate/generate-evidence.mjs , to avoid drift between documentation and script wording.

Instructions

1. Worktree Awareness: Large-scale documentation updates must be performed in the ../momei-docs directory, ensuring the documentation version is independent of the code development branch.
2. Directory Awareness: Always operate under the docs/ directory (except for the root directory's README.md). Understand the subdirectory structure: design/ (design), standards/ (specification), plan/ (plan), guide/ (guide).
3. Standard Alignment: Before writing documentation, you must read and follow documentation standards。
4. Cross-Reference: When writing documentation, correctly use relative paths to link to other documents.
5. Stay in Sync: When significant code changes occur, proactively suggest updating the related API documentation, design documentation, and the root directory's README.md。
6. Release and Audit Sync: If changes affect pre-release validation, evidence templates, or the Review Gate process, prioritize syncing docs/plan/todo.md, related standard documents, and script behavior descriptions.
7. Format Standards: Use standard Markdown format. For diagrams, use Mermaid syntax.
8. Reading First: When answering questions about "how to do", prioritize consulting the specification documents under docs/standards/ .
9. Site Maintenance: When directory structure changes are involved, consider updating the navigation and sidebar configuration in docs/.vitepress/config.ts accordingly.

Usage Example

Input: "Consult the API design specification regarding the definition of status codes." Action: Read docs/standards/api.md and extract the status code section.

Input: "Update the API documentation to include the new article publishing endpoint." Action: Read the code logic of server/api/posts/index.post.ts , then add the corresponding endpoint description in docs/design/api.md .