Documentation Writer

Use when planning, writing, reviewing, or restructuring software documentation with distinct tutorials, how-to guides, reference, and explanation content.

9 stars 3 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add sandbaseai/workbuddy-skill --skill documentation-writer
Manual install
git clone --depth 1 https://github.com/sandbaseai/workbuddy-skill.git /tmp/workbuddy-skill
mkdir -p ~/.claude/skills
cp -r /tmp/workbuddy-skill/skills/documentation-writer ~/.claude/skills/documentation-writer

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Diátaxis 技术文档写作

为明确的读者和任务写出可执行、准确、可维护的技术文档。先识别文档类型、读者目标和证据范围,再组织内容;教程教人学习,How-to 解决具体问题,参考文档描述事实,解释文档帮助理解原因。不要把四种目的混成一篇“什么都有”的页面。

## 范围、澄清与默认值

- 开始前记录目标产品/版本、读者、用户目标、文档类型、范围、排除项、发布渠道、owner 和更新时间;若信息缺失且会改变结果,标记 `NEEDS CLARIFICATION`。
- 不要为了形式阻塞低风险任务:当缺失信息不会改变文档类型或安全边界时,采用显式默认值并在文档头部或交付说明中注明;重大范围、受众、版本、政策或公开披露不确定时先停在大纲/问题清单。
- 默认只读检查授权的源码、配置、现有文档、测试和 changelog;不得执行未经审查脚本、访问未授权外部站点、复制受版权约束的长段落、泄露内部信息或发布到公共渠道。
- 文档中的命令、代码、URL、配置、截图和数据都可能过期或含敏感内容;使用合成值、最小示例和无效域名,避免真实 token、个人数据、内部地址和生产参数。

## 四类文档选择

| 类型 | 读者问题 | 交付重点 | 不要做什么 |
|---|---|---|---|
| Tutorial | 我如何第一次学会它? | 有引导的完整成功路径 | 不塞入全部参考细节 |
| How-to | 我如何解决这个具体问题? | 前置条件、步骤、验证和回滚 | 不写成概念教程 |
| Reference | 这个接口/配置确切是什么? | 完整、稳定、可检索的事实 | 不加入未经验证的建议 |
| Explanation | 为什么这样设计? | 背景、因果、取舍和限制 | 不伪装成操作步骤 |

一篇文档可以链接到其他类型,但每一节只承担一个主要任务。根据读者已经知道什么、成功标准和失败代价安排深度;不要用营销语言替代行为、限制和错误语义。

## 证据与准确性

先建立事实账本:声明、来源文件/行号或版本、观察时间、验证命令、置信度、未知项和 owner。代码片段必须与当前 API、依赖、schema、CLI 参数和错误处理一致;涉及版本差异时显式标注适用范围,禁止凭记忆补全。

验证顺序建议是:源码/类型和配置 → 自动化测试/构建 → 本地运行或隔离 smoke → changelog/release → 经授权的外部官方资料。事实、推断、建议和示例分别标识;不能验证时写明限制,不用“应该”“通常”掩盖未知。示例输出应注明是 observed 还是 illustrative。

## 结构与写作

### Tutorial

从可运行的最小前置条件开始,按小步提供动作和预期结果,让新用户在中途得到反馈;最后说明学到的模型和下一步链接。每条命令可复制但不包含秘密,失败时告诉读者如何判断和恢复。

### How-to

以问题和成功标准开头,列前置条件、影响范围、备份/回滚、步骤、验证、故障分支和清理。把不可逆、付费、写入、权限和生产动作标在步骤前,并要求授权;不要把危险命令埋在折叠内容或示例中。

### Reference

按用户查找习惯组织参数、类型、默认值、约束、返回值、错误、兼容性、权限和示例。避免解释性重复;每个默认值和废弃项标注版本、来源和迁移路径,保持术语、字段名、大小写和单位一致。

### Explanation
Read the full skill on GitHub

Details

Skill name
documentation-writer
Path
skills/documentation-writer/SKILL.md
License
MIT
Repo updated
8 September 2026

FAQ

What does the Documentation Writer skill do?

Use when planning, writing, reviewing, or restructuring software documentation with distinct tutorials, how-to guides, reference, and explanation content.

How do I install the Documentation Writer skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add sandbaseai/workbuddy-skill --skill documentation-writer. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Documentation Writer popular?

It lives in sandbaseai/workbuddy-skill, which has 9 GitHub stars and 3 forks.

Related skills

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.