documentation-specialist

Documentation Specialist Skill

Capabilities

• Document Retrieval: Quickly find and summarize design documents, specification documents and plan documents located under the docs/ directory.
• Document Generation: Automatically update or create new Markdown documents based on code changes.
• Specification Checking: Ensure documentation follows the project's documentation structure and style guide (as defined in AGENTS.md ).
• Plan Management: Able to read docs/plan/todo.md and docs/plan/roadmap.md to understand the current task status.

Instructions

1. Directory Awareness: Always operate under the docs/ directory. Understand the subdirectory structure: design/ (design), standards/ (specification), plan/ (plan).
2. Cross-referencing: When writing documentation, correctly use relative paths to link to other documents.
3. Stay in Sync: When significant code changes occur, proactively suggest updating the relevant API documentation or design documentation.
4. Format Specification: Use standard Markdown format. For diagrams, use Mermaid syntax.
5. Reading First: When answering "how to do" questions, prioritize consulting the specification documents under docs/standards/ .

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 in docs/design/api.md add the corresponding endpoint description.