crafting-effective-readmes

此工具作为文档架构师，协助开发人员与项目拥有者编写高效率的 README 文件，连接代码与理解之间的鸿沟。README 通常是贡献者、利益相关者或未来维护者接触项目的第一步；此技能确保您的项目文档针对受众的特定需求进行调整，无论是开源贡献者、浏览内部存储库的队友，还是研究配置文件的未来自己。通过结构化的流程，您可以在项目演进的同时维护高质量的文档。

此工具支持四项主要任务：创建初始项目文档、为新功能新增章节、更新过时信息，以及进行定期审查以确保与当前代码库的一致性。它运用多种模板，包含开源项目、个人作品集、内部团队存储库与技术性 XDG-config 文件的设置，确保每个情境都能提供适当的细节。

• 智慧型任务识别，引导您完成创建、扩充与维护阶段。

• 具备受众意识的模板，自动填充安装、使用方式、架构与授权等关键章节。

• 整合式检查清单，确保每个 README 皆包含明确的项目名称、简洁的目标说明以及可执行的示例。

• 主动式的审查循环，鼓励将文档与目前的套件状态、配置与依赖性进行比对。

• 关于风格与文笔的上下文指导，减少文档中的模棱两可与技术债。

• 在启动新项目时，请准备好定义项目类型、主要问题陈述以及最快速的安装或执行路径。

• 在审查阶段，此工具将协助您通过比对文档内容与目前项目状态（例如 package.json、主源代码文件）来识别过时的区段。

• 使用提供的模板参考 (oss.md, personal.md, internal.md, xdg-config.md) 作为内容基础，以维持一致性。

• 始终以工具的最终检查结束草拟过程：询问是否遗漏了任何关键的项目特定信息。

• 此技能专为希望减轻文档维护负担并提高项目入门成功率的软件开发人员、技术撰稿人与开源维护者所设计。