面向技术写作的 Agent Skills

技术写作技能帮助 agent 产出特定读者真正能用的文档。工作从需求开始,而不是从文字开始:教程带新手走通一条成功路径,操作指南为已经知道目标的人给出最短的可靠步骤,参考材料保持完整一致以便查阅,解释则涵盖背景和取舍,让读者能就主题进行推理。编辑和评审在发布前收紧准确性、术语和可读性,而信息设计决定什么该放在哪里,让整套文档保持可导航。使用排名列表时,先把你的任务与这些需求之一匹配,然后选择描述中点名该需求以及你想要交付物的技能。如果两个看起来接近,优先选与你读者起点知识匹配的那个。

8 个先看36 个推荐选项

从这些开始。

Technical writing is the craft of turning specialist knowledge into text a specific reader can use: first choose the need, then structure, draft, and review for accuracy.

这些是和这项工作最接近的结果。从第一条开始,打开后即可安装。

Write a lesson that walks a newcomer through one successful path.Write the shortest reliable procedure for a reader who already knows the goal.Write complete, consistent lookup material rather than a narrative.Write the context and tradeoffs so a reader can reason about the subject.Tighten accuracy, terminology, and readability before anything ships.Decide what belongs where so the set of docs is navigable as a whole.

36 个推荐选项

  1. 排名 04
    直接匹配

    documentation

    撰写并维护技术文档,涵盖 README、API 文档、运维手册、架构文档和入职指南。

    • How-to guides
    9,914 · 受欢迎程度
    查看 Agent Skill
  2. 排名 05
    直接匹配

    wiki-page-writer

    官方

    生成丰富的技术文档页面,包含深色模式 Mermaid 图表、源代码引用和第一性原理深度。适用于撰写文档、生成 wiki 页面、创建技术深度解析或记录特定组件或系统时。

    • How-to guides
    查看 Agent Skill
  3. 排名 06
    直接匹配

    docs-guard

    审查生成或变更的文档,对照源码验证每个引用的符号和代码示例,捕捉文档与代码的偏差。

    • How-to guides
    • Reference
    • Editing & review
    3,683 · 受欢迎程度
    查看 Agent Skill
  4. 排名 07
    直接匹配

    writing-guidelines

    官方

    依据写作规范审查文档/文章。当被要求“审查我的文档”、“检查写作风格”、“审计文章”、“审查文档语气和语调”或“对照写作手册检查此页面”时使用。

    查看 Agent Skill
  5. 排名 08
    直接匹配

    write-feature-docs

    根据规格为新功能起草完整文档页面,对照代码库验证说法,并提交文档 PR。

    • Information design
    18,197 · 受欢迎程度
    查看 Agent Skill
展开另外 28 个 Agent Skills
  1. 排名 09
    直接匹配

    documenting-contracts

    记录 HTTP API、消息负载、DTO、文件格式和 webhook,采用 DTO 优先目录和线类型细节层级。

    • Reference
    12,091 · 受欢迎程度
    查看 Agent Skill
  2. 排名 10
    直接匹配

    writing-runbooks

    撰写运维文档,如运行手册、设置指南和迁移指南,包含风险图例和症状优先的故障排查。

    • How-to guides
    12,422 · 受欢迎程度
    查看 Agent Skill
  3. 排名 11
    直接匹配

    documenting-legacy-codebases

    通过勘察表面、将论断建立在代码之上并构建可信的文档树,为现有文档不足的代码库编写文档。

    12,292 · 受欢迎程度
    查看 Agent Skill
  4. 排名 12
    直接匹配

    code-documenter

    生成并验证技术文档,包括 docstring、OpenAPI 规范、JSDoc、文档门户和用户指南。

    • Tutorials
    5,284 · 受欢迎程度
    查看 Agent Skill
  5. 排名 13
    直接匹配

    hads

    定义 Human-AI Document Standard,用于编写和验证人类与 AI 均可阅读的 Markdown 技术文档。

    • How-to guides
    6,170 · 受欢迎程度
    查看 Agent Skill
  6. 排名 14
    直接匹配

    typescript-docs

    使用 JSDoc、TypeDoc 和 ADR 生成 TypeScript 文档,并采用框架特定模式。

    • Reference
    4,049 · 受欢迎程度
    查看 Agent Skill
  7. 排名 15
    可能匹配

    diagramming-processes

    使用 ArchiMate 和 PlantUML 绘制业务流程、生命周期和交互图,遵循源文件纳入版本控制的规则。

    12,136 · 受欢迎程度
    查看 Agent Skill
  8. 排名 16
    可能匹配

    writing-design-docs

    撰写提案、RFC、设计文档和规格说明,包含提案骨架以及 Why & What 决策框。

    12,513 · 受欢迎程度
    查看 Agent Skill
  9. 排名 17
    可能匹配

    readme-blueprint-generator

    通过分析仓库文档和 copilot-instructions 文件生成全面的 README.md。

    • Tutorials
    9,607 · 受欢迎程度
    查看 Agent Skill
  10. 排名 18
    可能匹配

    comment-code-generate-a-tutorial

    重构 Python 脚本,添加教学注释,并生成适合初学者的 markdown 教程。

    • Tutorials
    • How-to guides
    • Editing & review
    8,852 · 受欢迎程度
    查看 Agent Skill
  11. 排名 19
    可能匹配

    spring-boot-openapi-documentation

    在 Spring Boot 应用中使用 SpringDoc OpenAPI 3.0 和 Swagger UI 生成 REST API 文档。

    3,858 · 受欢迎程度
    查看 Agent Skill
  12. 排名 20
    可能匹配

    writing-changelogs

    撰写变更日志条目、发布说明和交接摘要,遵循诚实惯例。

    12,419 · 受欢迎程度
    查看 Agent Skill
  13. 排名 21
    可能匹配

    architecture-decision-records

    编写和维护架构决策记录的模式,记录背景、决策和后果。

    19,354 · 受欢迎程度
    查看 Agent Skill
  14. 排名 22
    可能匹配

    article-writing

    以鲜明的声音撰写长篇文章、指南、教程和新闻通讯,并遵循结构和证据规则。

    11,090 · 受欢迎程度
    查看 Agent Skill
  15. 排名 23
    可能匹配

    changelog-generator

    根据 git 提交创建面向用户的变更日志,对变更分类并转化为客户友好的发布说明。

    • How-to guides
    7,008 · 受欢迎程度
    查看 Agent Skill
  16. 排名 24
    可能匹配

    writing-plans

    精选

    当你拥有多步骤任务的规格说明或需求时使用,在接触代码之前

    • How-to guides
    查看 Agent Skill
  17. 排名 25
    可能匹配

    writing-beats

    精选

    写作,开发;将原始素材组装成节拍旅程,在每个节拍依赖某个术语之前先为其打好基础。

    351,944 · 受欢迎程度
    查看 Agent Skill
  18. 排名 26
    可能匹配

    writing-shape

    精选

    写作,深度解析:将原始素材逐段塑造成一篇文章。

    351,444 · 受欢迎程度
    查看 Agent Skill
  19. 排名 27
    可能匹配

    ux-writing

    精选

    借助语气与风格系统撰写或审校 UI 文案(按钮、错误提示、空状态、微文案)。

    • How-to guides
    查看 Agent Skill
  20. 排名 28
    可能匹配

    spec-driven-implementation

    通过先编写 PRODUCT.md 和 TECH.md 再实施并保持其最新,推动规范优先工作流。

    27,755 · 受欢迎程度
    查看 Agent Skill
  21. 排名 29
    可能匹配

    jupyter-notebook

    官方

    当用户要求为实验、探索或教程创建、搭建或编辑 Jupyter notebook(`.ipynb`)时使用;优先使用内置模板,并运行辅助脚本 `new_notebook.py` 生成干净的起始 notebook。

    • Tutorials
    • How-to guides
    查看 Agent Skill
  22. 排名 30
    可能匹配

    writing-skills

    精选

    在创建新技能、编辑现有技能或部署前验证技能是否可用时使用。

    • Reference
    查看 Agent Skill
  23. 排名 31
    可能匹配

    writing-for-agents

    精选

    为 agents 编写文档。在创建或编辑 skills,或修改 AGENTS.md 或 CLAUDE.md 时使用。

    272,220 · 受欢迎程度
    查看 Agent Skill
  24. 排名 32
    可能匹配

    human-writing

    精选

    通用中文创作与改稿 Skill。用于知乎回答、论坛长帖、公众号文章、博客、评论、人物故事、历史叙事、新闻与行业解读、科普、教程、评测、个人叙事、小说、故事、对白、口播和演讲稿。默认写成一个见过事、查过材料、愿意把来龙去脉讲清楚的人在说话,重点保留中文互联网长回答与长帖的活人感和自然中文韵律,避免空泛的机构腔、喊口号式演说腔、营销腔和模型腔。非虚构长文先检查材料够不够,材料不足时研究、追问或缩短,绝不用重复解释灌字数。现实内容额外核验事实、引语、数据与用户亲历,虚构内容可以创造人物、场景、对白、心理与情节。成稿正文严禁冒号、破折号、“不是……而是……”及同类翻案句,并清除商业黑话和模型惯用黑话。不创建作者画像、个人规则库或个人写作 Skill。

    查看 Agent Skill
  25. 排名 33
    可能匹配

    domain-modeling

    构建并打磨项目的领域模型,撰写 CONTEXT.md 词汇表和 ADR。

    777,796 · 受欢迎程度
    查看 Agent Skill
  26. 排名 34
    可能匹配

    microsoft-docs

    官方

    通过查询官方文档来理解 Microsoft 技术。当用户询问某项功能如何工作、想要教程、需要任何 Microsoft 技术(Azure、.NET、M365、Windows、Power Platform 等)的配置选项、限制、配额或最佳实践时使用——即使用户没有提到“文档”。如果问题是理解概念而非编写代码,这就是合适的技能。

    • Tutorials
    查看 Agent Skill
  27. 排名 35
    可能匹配

    platform-docs-get

    从 Salesforce 自有域名检索官方 Salesforce 文档,为回答提供依据。

    • Reference
    6,231 · 受欢迎程度
    查看 Agent Skill
  28. 排名 36
    直接匹配

    doc-coauthoring

    官方

    引导用户通过结构化工作流共同撰写文档。当用户想要撰写文档、提案、技术规格、决策文档或类似结构化内容时使用。此工作流帮助用户高效传递上下文、通过迭代完善内容,并验证文档对读者有效。当用户提到撰写文档、创建提案、起草规格或类似文档任务时触发。

    查看 Agent Skill
这个话题涵盖什么

这个话题涵盖什么

每个子主题对应一类具体场景下的 Agent Skills。

Tutorials
Write a lesson that walks a newcomer through one successful path.
How-to guides
Write the shortest reliable procedure for a reader who already knows the goal.
Reference
Write complete, consistent lookup material rather than a narrative.
Explanation
Write the context and tradeoffs so a reader can reason about the subject.
Editing & review
Tighten accuracy, terminology, and readability before anything ships.
Information design
Decide what belongs where so the set of docs is navigable as a whole.
常见问题

常见问题

这个列表是如何排序的?
它按观察到的搜索需求排名。与该主题直接匹配的排在前面,并且对任何单个发布者设上限,以免一个来源占满页面。
我应该从哪个子主题开始?
从读者的需求出发。新手需要 tutorial,已知目标的人需要 how-to guide,查阅类工作需要 reference,权衡取舍的推理需要 explanation。
一个技能能同时覆盖起草和审阅吗?
编辑和审阅被视为一个独立子主题,与偏重起草的工作并列。如果你需要在交付前检查准确性、术语和可读性,就寻找明确提到该步骤的技能。
信息设计适合放在哪里?
信息设计决定什么内容该放在哪里,使整套文档作为一个整体可被导航。当问题在于跨文档的结构而非单个文档内的措辞时,就该用它。

如何安装 Agent Skill

从本页第一条开始。Claude Code 会读取放进 skills 目录的 SKILL.md:

  • Claude Code——把 technical-writing 的 SKILL.md 复制到 ~/.claude/skills/technical-writing/(个人使用),或 .claude/skills/technical-writing/(随项目共享)。
  • 从 registry 安装——运行 npx skills add riekelt/technical-writer@technical-writing。
  • 或者从 technical-writing 的来源下载 SKILL.md,放进上面的目录。

如何挑选 安装前先看出处和技能自身的说明。Official 与 Notable 标签描述的是技能来源。