用途
write-readme 用于按 Remix 仓库的风格撰写或重写包 README 文件。适合在起草新的包 README、修订已有 README 等场景中使用。其核心目标是把 README 写成面向真实用户的简洁包文档，而不是营销文案，也不是 API 转储。
工作流程
- 起草前先阅读包的 API，以及一到两个同类包的 README。
- 记录包当前实际存在的样子，而不是你希望它存在的样子。
- 安装部分结束后，尽快给出一个贴近真实生产环境的用法示例。
- 用具体示例覆盖每个主要功能。
- 最后以内部生态链接、外部相关工作以及许可证信息收尾。
结构
除非有强烈的包特定理由，否则使用以下章节顺序：
-
短包名（例如 fetch-router，而不是 @remix-run/fetch-router）
- 简介：用一两句话说明这个包做什么、为什么存在
-
Features：扁平的项目符号列表，列出主要亮点
-
Installation
-
Usage：一个贴近生产环境的示例，展示包在上下文中的用法
- 每个主要功能一节，每节配聚焦示例
-
Related Packages
-
Related Work
-
License
规则
- Installation 始终以
npm i remix开头。 - 如果包需要第三方依赖或 peer，请在安装部分中于 remix 之后显式列出。
- Usage 示例应从
remix/...导入，而不是从@remix-run/...。 - 第一个示例应看起来像真实的应用代码，而不是尽可能短的代码片段。
- 功能章节应展示如何在实际中使用该包的主要能力，必要时每个能力配一个示例。
- 正文保持紧凑。不要仅仅为了强制某一行长度，而在句子中间别扭地硬换行。
- 优先使用扁平的项目符号和短段落，而不是长篇解释性块。
- Related Packages 应指向 monorepo 中相关的 Remix 包。
- 跨文件或跨包的仓库链接使用完整 GitHub URL，这样 README 内容在复制到生成的文档中后仍然可用。同文档锚点和 README 自链接保持相对路径。
- Related Work 应指向有助于读者定位该包的外部库、规范、标准或先前工作。
- License 应使用仓库的标准措辞和链接。
检查清单
- 简介是否用一两句话说明了这个包？
- 功能列表是否快速呈现出该包的主要价值？
- 安装部分是否使用了
npm i remix？ - 主用法示例是否展示了贴近生产的场景？
- 每个主要功能是否都有示例？
- README 是否以 Related Packages、Related Work 和 License 收尾？
- 正文读起来是否自然，没有别扭的人为换行？
适用场景与限制
该技能面向按 Remix 仓库风格编写或重写包 README 的任务，适合维护者、贡献者或需要统一文档风格的团队。其规则围绕 Remix 生态约定展开，因此对非 Remix 项目或不同文档规范的适配方式暂未提供。具体支持的平台、收费与价格信息暂未提供。