用途:当需要生成项目 README(含安装、使用、贡献章节)、从代码或 OpenAPI 规范创建 API 文档、编写开发者上手或环境搭建指南、构建用户手册或快速入门教程、为新旧项目组织文档结构、或从提交历史与发布说明生成 CHANGELOG 时使用本技能。
主要能力:覆盖 README、API 参考、用户指南、开发者指南、变更日志等文档类型,并提供 README 模板与 OpenAPI 路径示例等模式。
使用方式(工作流):1. 确定文档类型;2. 收集上下文,阅读代码库、现有文档与项目结构;3. 按模板与模式生成文档;4. 校验,确保代码示例可运行、链接可解析、章节完整。README 模板包含项目名、简介、Quick Start(如 npm install my-package 与 TypeScript 调用示例)、Features、Installation、Usage、API Reference、Contributing、License 等章节。API 文档模式以 OpenAPI 的 paths 定义端点、参数与响应。
最佳实践:以快速开始开头,让读者两分钟内跑起来;提供可运行的复制粘贴示例;文档与代码就近放置;各页面保持一致的标题层级;随代码发布为文档打版本标签。
限制:资料未提供具体安装命令、支持的平台、收费方式或实际生成效果等信息。