mcpField
T
technical-writer

technical-writer

github.com/404kidwiz文档处理105 次安装
代码仓库

关于 technical-writer

technical-writer 是面向开发者、用户和利益相关者的技术文档撰写与维护技能，涵盖 API 参考、教程、发行说明等类型，并提供内容编写和审阅流程。

主要功能

  1. 01API 文档和参考指南
  2. 02用户指南与入门教程
  3. 03知识库、常见问题和 README
  4. 04架构与系统设计文档
  5. 05发行说明和更新日志
  6. 06文档审阅与维护建议

适用场景

  1. 01记录 API 端点和数据模型
  2. 02为新用户或开发者编写教程
  3. 03统一项目内的文档风格
  4. 04撰写面向用户的发行说明

安装

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

$npx skills add https://github.com/404kidwiz/claude-supercode-skills --skill technical-writer

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

详细介绍

技术写作者

用途

为开发者、用户和利益相关方编写高效技术文档提供专业知识。专注于 API 文档、用户指南、教程，以及构建可维护的文档系统，以服务不同受众。

适用场景

  • 编写 API 文档和参考指南
  • 创建用户指南和入门教程
  • 构建知识库和常见问题解答
  • 编写 README 文件和项目文档
  • 创建面向开发者的入门文档
  • 编写架构和系统设计文档
  • 编写发行说明和变更日志
  • 统一不同项目的文档风格

快速开始

在以下情况下调用此技能：

  • 编写 API 文档和参考指南
  • 创建用户指南和入门教程
  • 构建知识库和常见问题解答
  • 编写 README 文件和项目文档
  • 创建面向开发者的入门文档

以下情况不要调用：

  • 编写代码注释 → 由开发者负责
  • 创建 ADR → 使用 document-writer
  • 编写营销内容 → 使用 content-marketer
  • 设计文档基础设施 → 使用 documentation-engineer

决策框架

Documentation Type?
├── API Reference → OpenAPI spec + generated docs
├── Getting Started → Quick start guide + first success
├── Conceptual → Architecture overview + mental models
├── How-To → Task-focused step-by-step guides
├── Troubleshooting → Problem-solution format
└── Release Notes → User-focused change descriptions

核心工作流

1. API 文档
  1. 检查 API 端点和数据模型
  2. 编写清晰的端点说明，并列出使用场景
  3. 使用示例说明请求和响应格式
  4. 说明身份验证和错误处理
  5. 添加多种语言的代码示例
  6. 测试所有示例，确保准确无误
  7. 为 API 变更设置版本管理
2. 教程开发
  1. 确定目标受众和先决条件
  2. 明确学习目标和预期成果
  3. 按难度递增的方式组织内容
  4. 编写包含背景说明的分步指南
  5. 添加可复制并运行的代码示例
  6. 针对常见问题提供故障排除说明
  7. 在全新环境中测试教程流程
3. 文档维护
  1. 制定文档审查计划
  2. 设置自动检查，发现失效链接
  3. 将文档更新与代码变更同步跟踪
  4. 收集并纳入用户反馈
  5. 在 API 变更时更新示例
  6. 适当归档已弃用的内容
  7. 监控分析数据，寻找改进机会

最佳实践

  • 围绕读者的目标编写，而不是围绕系统结构
  • 使用统一术语，并制定术语表
  • 提供可供用户复制的可运行代码示例
  • 在干净的环境中测试所有操作步骤
  • 保持句子简短、段落聚焦
  • 在有助于阐明内容时使用图示（示意图、屏幕截图）

反面模式

  • 以开发者为中心的写法 → 聚焦用户的任务和目标
  • 过时的示例 → 自动测试代码示例
  • 大段文字 → 使用标题、列表和留白
  • 假设读者已掌握相关知识 → 明确说明先决条件
  • 一次性编写 → 将文档视为持续更新的内容

评论

支持 Markdown