用途:ProjectWiki 面向开发人员、技术负责人和项目经理,帮助快速创建并维护项目文档,覆盖新项目启动、版本发布、需求变更等场景。
主要能力:一是模板加脚本生成,内置 20 多个模板,含基础文档(README、CHANGELOG、CONTRIBUTING、LICENSE)、架构文档(ARCHITECTURE、api-template、design-doc-template)、需求文档与规划文档,输出标准 Markdown。二是文档流程管理,包括生成、一致性检查、变更同步与健康检查,检查术语命名、逻辑、格式、参数、图表、权限、时间进度等。三是知识库查询,提供技术框架、设计模式、设计原则与一致性规则速查。
使用方式:先写配置文件 config.yaml(含 project_name、username、version、description),再运行生成命令,例如 uv run python scripts/generate_doc.py --template basic/README.md --output README.md --config config.yaml。可用 --list 查看模板,用 scripts/normalize_templates.py 标准化模板变量。变量格式为 {{variable_name}},必填加 *,可选加 ?;配置支持 YAML 与 JSON。
适用场景:新项目初始化文档、批量生成基础与架构文档、API 文档填写、版本发布前版本号与清单检查、技术选型查询以及使用标准化工作流程执行任务。
限制:资料未提供收费、平台兼容性与性能数据;生成器依赖 Python 与 uv 命令环境,文档需人工校验与持续维护,模板变量名须与模板一致。