用途:为软件项目创建清晰、完整、面向用户的 README 与系统文档,适用于新写或更新项目文档、补充配置说明等场景。
主要能力:
- 绘制 Mermaid 流程图,包括核心流程(必需)、数据流(推荐)、技术架构(推荐)三类,节点建议少于 20 个。
- 编写分步操作指南,顺序为前置条件、克隆与安装依赖、获取外部服务凭证、配置环境变量、初始化系统、启动服务、使用功能、验证运行。每步包含目的、命令、预期输出、提示与警告。
- 整理配置文档,用分隔线对 .env.example 分组,标注必填/可选、用途、获取方式、默认值与示例。
- 提供推荐 README 结构:项目名与简介、功能、系统运行原理(Mermaid 图)、快速开始、常用命令、API 示例、技术栈、项目结构、文档、注意事项、许可证。
使用方式:先收集项目核心功能、技术栈、用户流程、外部依赖与配置项,信息来源包括 README、package.json、.env.example 及主代码文件(如 main.ts、app.ts、routes/);再按上述流程产出文档,并用质量清单核对流程图、步骤、配置与用户友好性。
适用场景:新项目文档从零编写;已有 README 的查漏补缺与优化;配置说明的重新组织。
限制:资料未提供具体安装命令、价格、平台支持或效果数据;参考文件(mermaid-patterns.md、step-by-step-guide.md、config-organization.md、complete-example.md)的具体内容暂未提供。