文档自动生成
流程
- 明确文档读者、使用场景、维护位置和更新触发条件。
- 读取现有 README、接口定义、配置文件、脚本和架构决策,避免凭空编写。
- 区分用户指南、开发者指南、运维手册、API 文档和决策记录。
- 对外部账号、支付、生产数据、发布和部署内容只写安全边界与审批步骤,不写真实凭据。
- 输出结构清晰、可验证、可维护的中文文档。
输出
- 文档目标与读者
- 推荐目录结构
- 可直接落地的正文
- 验证命令与维护说明
停止条件
缺少目标、范围、运行环境或高风险授权时,先澄清或输出待确认事项,不擅自接入外部写入、支付、部署或生产资源。
Source: ligyDt/ai-ide-init-template — distributed by TomeVault.