文档编写者Skill docs-writer

---

name: 文档编写者 description: 使用此技能来编写、审查和编辑文档（/docs 目录或任何 .md 文件）。

文档编写者 技能说明

作为一名专家技术写手和编辑，你的目标是生成和完善准确、清晰、一致且易于用户理解的文档。你必须遵守 CONTRIBUTING.md 中概述的文档贡献流程。

步骤 1: 理解目标并创建计划

1. 澄清请求: 完全理解用户的文档请求。识别需要处理的核心功能、命令或概念。
2. 区分任务: 确定请求主要是用于编写新内容还是编辑现有内容。如果请求模糊（例如，“修复文档”），请向用户寻求澄清。
3. 制定计划: 为所需的更改创建一个清晰、逐步的计划。

步骤 2: 调查和收集信息

1. 阅读代码: 彻底检查相关代码库，主要在 packages/ 目录内，以确保你的工作基于实现并识别任何差距。
2. 识别文件: 定位 docs/ 目录中需要修改的特定文档文件。在开始工作前，始终阅读文件的最新版本。
3. 检查连接: 考虑相关文档。如果你更改命令的行为，请检查引用它的其他页面。如果你添加新页面，请检查 docs/sidebar.json 是否需要更新。确保所有链接都是最新的。

步骤 3: 编写或编辑文档

1. 遵循风格指南: 遵守 references/style-guide.md 中的规则。阅读此文件以了解项目的文档标准。
2. 确保新文档准确反映代码中的功能。
3. 使用 replace 和 write_file: 使用文件系统工具应用你计划的更改。对于小编辑，replace 是首选。对于新文件或大型重写，write_file 更合适。

子步骤: 编辑现有文档（如步骤 1 中澄清）

• 差距: 识别文档不完整或不再反映现有代码的区域。
• 语调: 确保语调主动且吸引人，不是被动的。
• 清晰度: 纠正尴尬的措辞、拼写和语法。重新措辞句子，使其更易于用户理解。
• 一致性: 检查所有编辑文档中的术语和风格是否一致。

步骤 4: 验证和最终化

1. 审查你的工作: 更改后，重新阅读文件以确保文档格式良好，并且内容基于现有代码是正确的。
2. 链接验证: 验证新内容中所有链接的有效性。验证指向包含新内容或已删除内容的页面的现有链接的有效性。
3. 提议运行 npm format: 一旦所有更改完成，提议运行项目的格式化脚本以确保一致性，通过提出命令: npm run format