🚀 快速安装

复制以下命令并运行，立即安装此 Skill：

npx skills add https://skills.sh/anthropics/knowledge-work-plugins/documentation

💡 提示：需要 Node.js 和 NPM

技术文档编写 (Technical Documentation)

为不同的受众和目的编写清晰、可维护的技术文档。

文档类型 (Document Types)

README

  • 这是什么以及它为什么存在 (What this is and why it exists)
  • 快速入门（5 分钟内获得首次成功）(Quick start – < 5 minutes to first success)
  • 配置和使用 (Configuration and usage)
  • 贡献指南 (Contributing guide)

API 文档 (API Documentation)

  • 端点参考，包含请求/响应示例 (Endpoint reference with request/response examples)
  • 认证和错误码 (Authentication and error codes)
  • 速率限制和分页 (Rate limits and pagination)
  • SDK 示例 (SDK examples)

操作手册 (Runbook)

  • 何时使用此操作手册 (When to use this runbook)
  • 前提条件和所需权限 (Prerequisites and access needed)
  • 分步操作流程 (Step-by-step procedure)
  • 回滚步骤 (Rollback steps)
  • 升级路径 (Escalation path)

架构文档 (Architecture Doc)

  • 背景和目标 (Context and goals)
  • 带图表的高层设计 (High-level design with diagrams)
  • 关键决策和权衡 (Key decisions and trade-offs)
  • 数据流和集成点 (Data flow and integration points)

入门指南 (Onboarding Guide)

  • 环境设置 (Environment setup)
  • 关键系统及其连接方式 (Key systems and how they connect)
  • 带有操作演示的常见任务 (Common tasks with walkthroughs)
  • 遇到问题该找谁 (Who to ask for what)

原则 (Principles)

  1. 为读者而写 (Write for the reader) — 谁是读者？他们需要什么？(Who is reading this and what do they need?)
  2. 最重要的信息放在最前面 (Start with the most useful information) — 不要埋没要点 (Don’t bury the lede)
  3. 展示，而非讲述 (Show, don’t tell) — 代码示例、命令、截图 (Code examples, commands, screenshots)
  4. 保持文档最新 (Keep it current) — 过时的文档比没有文档更糟糕 (Outdated docs are worse than no docs)
  5. 链接而非复制 (Link, don’t duplicate) — 引用其他文档而非复制内容 (Reference other docs instead of copying)

📄 原始文档

完整文档（英文）：

https://skills.sh/anthropics/knowledge-work-plugins/documentation

💡 提示：点击上方链接查看 skills.sh 原始英文文档，方便对照翻译。

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。