专业技术文档写作 Skill,让 Claude 在写技术文档时遵循 Diátaxis 框架、企业级写作规范,产出符合 docs 站点标准的产品手册、推广文章、最佳实践。
| 输出类型 | 典型形态 | 核心指标 |
|---|---|---|
| 产品手册 | 用户手册、快速入门、API 文档、安装部署指南、FAQ、Release Note | 任务完成率、自助率 |
| 推广文章 | 产品介绍、解决方案、客户案例、公众号软文 | 阅读量、转化率 |
| 最佳实践 | 场景化部署指南、架构方案、踩坑总结、性能调优 | 引用次数、复用率 |
tech-writer/
├── SKILL.md # 主文档:流程框架 + 门禁清单
├── references/
│ ├── product_docs.md # 产品手册模板(Diátaxis 四象限)
│ ├── promo_articles.md # 推广文章模板(三大对标风格)
│ ├── best_practices.md # 最佳实践模板(四段式)
│ ├── writing_style.md # 写作风格规范(4C 检查清单)
│ └── platform_context.md # 平台上下文(术语表 + 红线)
技能强制执行四层门禁:
- 类型识别:先归类(手册/推广/最佳实践),再细分 Diátaxis 四象限
- 5W 分析:明确 WHO/WHAT/WHEN/WHERE/WHY
- 4C 自检:Correctness/Clarity/Conciseness/Consistency
- 敏感信息扫描:客户名、内部代号、未发布功能、财务数据
当用户说:
- "写文档/写手册/写指南/写教程/写 Release Note/写 FAQ/写 API 文档"
- "写一篇产品介绍/写方案/写案例/写公众号文章/写技术稿"
- "写最佳实践/写部署方案/写踩坑总结"
- "整理这份草稿/优化这段技术文案"
- 上传 PRD、需求文档、功能截图、API 定义要求转化为文档
| 风格 | 姿态 | 适用场景 |
|---|---|---|
| 风格 A | 教学型、第二人称、克制陈述 | 标准产品介绍、接入实践、客户案例 |
| 风格 B | 第一人称体验、对比句式、数据冲击 | AI 新功能发布、爆款传播文(需降温处理) |
| 风格 C | 团队视角、业务规模锚定、工程深度 | 架构解析、性能优化、稳定性实践 |
以下内容绝不出现:
- ❌ 未发布功能、未公开数据、未官宣合作
- ❌ 真实客户名/客户 logo(未授权)
- ❌ 真实人员姓名、手机号、邮箱
- ❌ 真实账号密码、API Key、Token、内网 IP
- ❌ 内部代号、未对外品牌名、组织架构
- ❌ "行业领先"、"全球首创"等无依据最高级
| 任务 | 应调用的 Skill |
|---|---|
| 周报、汇报材料 | weekly-report |
| PPT 演示 | kingdee-ppt |
| 开发者社区运营策略 | kingdee-dev-ecosystem |
| 合作伙伴沟通邮件 | nvc |
技能融合以下公开写作标准:
- Diátaxis 文档框架(diataxis.fr)
- Google Developer Documentation Style Guide
- Microsoft Writing Style Guide
- AWS 文档惯例
- Write the Docs 社区原则
适用版本:平台 V7.0+