documentation-standards
This skill should be used when writing or updating module documentation, running /sync-architecture, or when generating architecture docs. Provides the module doc template, writing style rules, and staleness detection.
This skill should be used when writing or updating module documentation, running /sync-architecture, or when generating architecture docs. Provides the module doc template, writing style rules, and staleness detection.
Use this skill at the end of a task to ensure documentation matches the code.
Automatically number new markdown documentation files in the docs/ folder using a sequential numbering system (e.g., 00_, 01_, 02_).
Search and reference Microsoft code samples and SDK documentation
Guides external contributors through the MCP SDL3 Server contribution process. Use when someone wants to contribute to the project, add SDL3 functions, implement new features, or understand the contribution workflow. Covers quick start, project structure, testing requirements, and submission guidelines.
Will handle creation of Atlassian Confluence release documentation creation
WHEN: API documentation, JSDoc/TSDoc comments, Props documentation, Storybook story writing WHAT: Function/class/type JSDoc + React Props table + Markdown API docs + Storybook stories WHEN NOT: README writing → readme-generator, Code explanation → code-reviewer
MANDATORY for ALL GDScript/.gd files and Godot resources (.tscn, .tres). Invoke this skill FIRST before writing ANY Godot code—never write GDScript directly without this skill. Provides documentation lookup, syntax checking, and testing instructions.
Use when documenting Python research code usage, setup, and experiment reproduction.
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns.
Review and update Python documentation to match project standards. Use when (1) writing new code that needs documentation, (2) reviewing existing code for documentation gaps, (3) updating docstrings after code changes, (4) adding inline comments to complex logic, (5) organizing imports. Enforces Google-style docstrings, beginner-friendly inline comments, and proper import structure.
Guidelines for using the Context7 MCP server to fetch real-time documentation and code examples.
Update or create API documentation after making changes to the public interface of an API. Use when modifying existing endpoints, introducing new endpoints, or when API implementation changes are complete and tested.
Creates detailed specification documents using standardized templates. Focuses on clarity, rigor, and implementability, utilizing `spec-refactoring` for final polish.
Standards for documenting codebases. Use when writing documentation, deciding where docs should go, reviewing doc quality, or updating docs after code changes. Covers folder structure, content guidelines, and maintenance workflows.
为单个系统设计详细的技术文档。负责架构图、接口设计、数据模型、Trade-offs讨论等。
Apply when creating or editing AI guidance documents ('**/AGENTS.md', '.cursor/**/*.md')