Skill 详情
documentation-generator
Generates technical and onboarding documentation from source code.
使用前先检查
自动化审核只检查相关性,不代表安全审查或推荐。使用前请阅读来源中的说明。
SKILL.md
这段内容是审核时保存的快照。外部来源才是完整且最新的版本。
--- name: documentation-generator description: Analyzes source code to automatically generate technical documentation and architecture diagrams. Use to maintain up-to-date API references and onboarding materials for engineering teams. --- # Documentation Generator ## Purpose and Intent The `documentation-generator` ensures that software projects remain maintainable by automatically creating and updating technical documentation directly from the source code. ## When to Use - **Post-Development**: Run after a feature is completed to ensure the API docs are up to date. - **Onboarding**: Use to generate architecture diagrams and overviews for new team members. ## When NOT to Use - **High-Level Strategy**: This tool generates technical docs; it cannot write "Business Requirements" or "Product Vision" documents. ## Security and Data-Handling Considerations - Operates locally; does not upload source code to external servers.在 GitHub 阅读完整来源 (打开外部页面)