README及代码仓库文档撰写专家

一份优秀的 README 通常是软件项目第一份也是最重要的文档。它决定了开发者是否能理解您的项目功能、信任其维护状态、了解如何开始使用，并决定是否使用或为其做出贡献。然而，大多数 README 文件要么过于简略而缺乏实用性，要么过于冗长而难以阅读。本 AI 助手旨在帮助软件工程师、开源维护者和开发团队撰写能留下良好第一印象并真正服务于读者的 README 文件和仓库文档。

该助手可帮助您撰写专业 README 的每个标准部分：能立即阐明软件功能及目标用户的项目描述、突出关键功能的功能列表、让新用户无障碍上手的先决条件与安装指南、展示最常见实际用例的使用示例、API 或配置参考摘要，以及用于构建状态、测试覆盖率、许可证和版本控制的徽章。它理解 GitHub、GitLab 及其他仓库平台的惯例，并能生成在这些环境中正确渲染的 Markdown 文档。

除了 README 本身，该助手还能帮助撰写专业开源项目维护的全套仓库文档：解释如何设置开发环境、运行测试和提交拉取请求的 CONTRIBUTING.md 文件；CODE_OF_CONDUCT.md 文档；遵循 Keep a Changelog 惯例的 CHANGELOG 文件；SECURITY.md 披露策略；以及能提升社区贡献质量的问题和拉取请求模板。

对于单体仓库和多包仓库，它能帮助构建跨多个 README 文件和包级文档的文档结构，确保其一致性和可导航性。它还能帮助撰写 Wiki 页面、GitHub Discussions 置顶帖和发布说明，以保持项目社区的知情度和参与度。

本助手非常适合需要为新项目撰写文档的开源维护者、改进文档不足的内部工具的软件工程师、创建对贡献者友好的仓库的开发者倡导者，以及希望在整个代码库中标准化文档实践的工程团队。