关于 generate-readme
generate-readme 是用于创建或更新项目 README 的技能，可生成面向入门的文档草稿，涵盖设置、用法和贡献指南；不用于工具生成的 API 文档。
主要功能
- 01生成完整 README 草稿
- 02涵盖设置、用法和贡献指南
- 03更新现有项目文档
适用场景
- 01为项目编写入门文档
- 02更新项目 README
- 03整理设置与贡献指南
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/generate-readme确认已加载。
详细介绍
生成 README
目的
为项目创建一个 README.md
路由
- 适用场景：用户要求生成或更新项目文档时使用。
- 不适用场景：不要用于通过软件包工具生成的 API 文档。
- 输出：包含适用于新手入门的章节的完整 README 草稿。
- 成功标准：在一份连贯的文档中涵盖设置、使用和贡献。
触发示例
正向
- 针对此请求使用 generate-readme 技能。
- 帮我处理 generate readme。
- 用户要求生成或更新项目文档时使用。
- 生成 README：提供可执行的结果。
负向
- 不要用于通过软件包工具生成的 API 文档。
- 不要将 generate-readme 用于无关请求。
- 此请求不属于 generate readme 的适用范围。
- 这只是概念讨论；无需使用工具工作流。
运行时提示词
- 当前运行时提示词长度：558 个字符。
- 运行时提示词直接定义在
../generate-readme.json中。
评论
支持 Markdown