用途:为任意项目生成完整、专业的文档模板,覆盖开源公开项目、内部项目、库和应用等类型。
主要能力:按六步工作流运作——判断项目类型;选择对应模板;填入项目特定信息;补充相关章节;检查完整性;统一格式风格。内置模板包括 README.md(必备,含概述、功能、快速开始、安装、用法、配置等)、CONTRIBUTING.md、LICENSE(MIT、Apache 2.0、GPL、BSD 等)、CODE_OF_CONDUCT.md、SECURITY.md、CHANGELOG.md(遵循 Keep a Changelog 格式),并可扩展 API.md、ARCHITECTURE.md、DEPLOYMENT.md、DEVELOPMENT.md、FAQ.md、TROUBLESHOOTING.md 及 .github 的 issue/PR 模板。
使用方式:资料给出的 README 快速开始命令为 git clone、npm install、npm run dev;安装部分涉及 Node.js 20+、npm 或 pnpm、PostgreSQL 15+(如适用)、cp .env.example .env、npm run db:migrate、npm run db:seed;测试命令为 npm test、npm run test:coverage。贡献流程为 fork、建分支、改代码、加测试、跑测试、按 Conventional Commits 提交、推送并发起 PR。
适用场景:开源与内部项目的文档初始化与补齐,按库/包(侧重 API 与用法)、应用(侧重安装配置部署)、CLI 工具(侧重命令与选项)、内部工具(侧重访问与公司流程)区分重点。
限制:资料未提供收费、价格、平台支持、运行效果及依赖安装方式等具体信息,暂未提供。