用途:为代码项目生成和维护文档,覆盖 README、API 文档、变更日志和架构文档。
主要能力:明确何时需要更新文档(新增功能、行为变更、配置更新、破坏性变更);文档可放在代码旁(docstring、注释)、仓库内(README、docs 目录)或自动生成(API、类型文档)。README 模板包含项目名、一句话描述、Quick Start、安装、用法、API 链接、贡献和许可证。API 文档支持 TypeDoc、Sphinx、godoc、JSDoc。变更日志采用 Keep a Changelog 格式,分 Added、Changed、Deprecated、Removed、Fixed、Security。架构文档涵盖 ADR、图表和系统概览。
使用方式:提供生成命令,如 TypeScript/JavaScript 用 npx typedoc --out docs src/index.ts、npx jsdoc src/ -d docs/、npx api-extractor run;Python 用 sphinx-build -b html docs docs/_build、pdoc --output-dir docs src/、mkdocs serve;Go 用 godoc -http=:6060、swag init -g cmd/server/main.go。工作流为识别需文档内容、生成或更新、验证链接与示例、提交(如 docs: update API documentation)。
最佳实践:在代码中写文档、尽量自动生成、保持 README 精简并链接详细文档、文档与代码同仓库同 PR、测试示例可运行。
限制:资料未提供具体收费、价格、平台支持范围或效果数据。