用途:该技能适用于创建新的 README 或文档文件、为现有 README 补充新功能、记录项目安装与配置、编写用法示例和 API 参考、生成贡献指南或快速入门,以及改善文档的清晰度与结构。
主要能力:提供一套标准 README 结构,包括项目名称与简介、功能列表、安装、快速开始、文档链接、API 参考、示例、配置、故障排查、贡献指南和许可证。核心工作流分五步:收集项目信息(目的、目标读者、关键功能、技术栈、项目结构);按标准结构搭建框架;撰写具体内容;添加可运行示例;完成前做质量检查(首段说明目的、安装完整、示例可运行、目录与章节一致、链接有效、格式统一、无拼写语法错误)。
使用方式:按技能描述的工作流逐步执行,先分析项目再组织文档。示例应真实可复制,快速开始保持精简(不超过 10 行代码),复杂安装步骤链接到独立指南。技能还要求遵循记忆协议:开始前读取 .claude/context/memory/learnings.md,完成后将新模式、问题、决策分别写入 learnings.md、issues.md、decisions.md。
适用场景:新项目初始化文档、功能发布后同步更新 README、为库编写 API 参考与用法示例、补充贡献指南。
限制与注意事项:技能强调首段必须回答“解决什么问题”,避免营销式空话,使用具体数据而非模糊表述;README 需与代码同步更新,避免过期命令和失效链接;不提供具体收费、平台或效果信息,相关资料暂未提供。