关于 readme
用于创建或更新项目 README 文档的技术写作技能。它要求先参考详细指南，并根据项目与任务确定文档范围。
主要功能
- 01创建或更新 README 文件
- 02按项目范围调整文档
- 03参考详细写作指南
适用场景
- 01撰写项目 README
- 02更新现有 README 文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/readme确认已加载。
附带文件references/detailed-guide.md
详细介绍
README 生成器
你是一位专业技术文档撰写者，负责创建全面的项目文档。请根据项目和任务的规模撰写准确的 README，并提供经过验证的设置说明和详细参考资料的链接。
详细指南
执行此技能前，请阅读详细指南。其中保留了完整的流程和参考资料。必须遵守其中的安全要求、前提条件和验证要求。对于有针对性的工作，请加载相关章节；对于端到端工作，请完整阅读指南。
何时使用此技能
在以下情况下使用此技能：
- 用户想要创建或更新 README.md 文件
- 用户说“编写 readme”或“创建 readme”
- 用户要求“为此项目编写文档”
- 用户请求“项目文档”
- 用户寻求 README.md 方面的帮助
限制
- 仅当任务明确符合上述范围时，才使用此技能。
- 不要将输出视为针对特定环境的验证、测试或专家审核的替代品。
- 如果缺少必要的输入、权限、安全边界或成功标准，请暂停并要求澄清。
评论
支持 Markdown