mcpField
W
write-readme

write-readme

github.com/remix-run开发33.4k47 次安装今天更新
代码仓库

关于 write-readme

用于撰写简洁、面向用户的软件包 README，并准确反映现有功能。它提供结构、示例、安装说明及相关项目链接的写作指引。

主要功能

  1. 01README 结构指引
  2. 02面向生产场景的使用示例
  3. 03软件包功能文档
  4. 04安装与依赖说明
  5. 05相关项目与许可证章节

适用场景

  1. 01起草软件包 README
  2. 02说明软件包的实际用法
  3. 03检查 README 结构与完整性

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/remix-run/remix --skill write-readme

安装后在 Claude Code 中输入/write-readme确认已加载。

附带文件agents/openai.yaml

详细介绍

编写 Readme

概述

将 README 文件起草为面向真实用户的简洁包文档，而不是营销文案或 API 罗列。沿用本仓库中使用的结构，让示例面向生产环境，并避免在行文中出现生硬的手动换行。

工作流

  1. 在起草前，先阅读包的 API 以及至少一两个同级包的 README。
  2. 按包当前的实际状态来记录，而不是记录你希望它成为的样子。
  3. 安装部分结束后，立即以一个贴近真实生产的用法示例开头。
  4. 为每个主要功能配一个具体示例。
  5. 以内部生态链接、外部相关工作以及许可证信息收尾。

结构

除非有强烈的包特定理由，否则请使用以下章节顺序：

  1. # short package-name（即 fetch-router 而非 @remix-run/fetch-router）
  2. 简介：用一两句话说明该包的作用以及它为何存在
  3. ## Features：以扁平的项目符号列表列出主要亮点
  4. ## Installation
  5. ## Usage：一个类似生产的示例，展示该包在上下文中的用法
  6. 每个主要功能各一个章节，每节配以聚焦的示例
  7. ## Related Packages
  8. ## Related Work
  9. ## License

规则

  • 安装部分应始终以以下内容开头：
npm i remix
  • 如果该包需要第三方依赖或 peer，请在安装部分中于 remix 之后明确列出。
  • 用法示例应从 remix/... 导入，而不是 @remix-run/...。
  • 第一个示例应看起来像真实的应用代码，而不是尽可能最小的代码片段。
  • 功能章节应展示如何在实际中使用该包的主要能力，如有帮助，可为每项能力配一个示例。
  • 保持行文紧凑。不要仅仅为了强制某一行长度而在句子中间的生硬位置手动换行。
  • 优先使用扁平的项目符号和简短段落，而不是长篇解释性内容块。
  • Related Packages 应指向 monorepo 中相关的 Remix 包。
  • 对于跨文件或跨包的仓库链接，请使用完整的 GitHub URL，以便 README 内容在复制进生成的文档后仍然可用。同一文档内的锚点和 README 自链接保持相对路径。
  • Related Work 应指向外部库、规范、标准或前人工作，帮助读者定位该包。
  • License 应使用仓库的标准措辞和链接。

检查清单

  • 简介是否用一两句话解释了该包？
  • 功能列表是否快速呈现了该包的主要价值？
  • 安装部分是否使用了 npm i remix？
  • 主要用法示例是否展示了贴近真实的生产场景？
  • 每个主要功能是否都有示例？
  • README 是否以 Related Packages、Related Work 和 License 结尾？
  • 行文读起来是否自然，没有生硬的手动换行？

评论

支持 Markdown