documentation-generator
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDocumentation Generator
文档生成器
Purpose and Intent
用途与目标
The ensures that software projects remain maintainable by automatically creating and updating technical documentation directly from the source code.
documentation-generatordocumentation-generatorWhen 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.
- 开发完成后：在功能开发完成后运行，确保API文档是最新的。
- 团队入职：用于为新团队成员生成架构图和项目概览。
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.
- 本地运行；不会将源代码上传至外部服务器。