文档越写越乱?这款Skill先分用途

帮你按照 Diátaxis 框架创建高质量技术文档。

documentation-writer 是按 Diátaxis 方法编写软件文档的 Skill。你提供产品资料、读者和写作目标,它会先判断文档用途,再提出结构,确认后撰写 Markdown 正文。

新手想完成第一次操作,熟手想解决眼前故障,读者需要的顺序并不一样。它把文档分成四类:带人学会的教程、解决具体问题的操作指南、供查询的参考资料,以及解释原理的文章。

如果把参数词典塞进新手第一步,把背景讨论插在紧急排错步骤中,内容即使正确也可能难用。先选用途,才知道哪些信息该展开、哪些应另放一页。

适合维护开发者文档或帮助中心的人。现有文档可作为术语和语气参考,但新稿仍应围绕当前用户的任务组织,不是把旧段落换个顺序再拼起来。

分类:文档办公

来源仓库:github/awesome-copilot

适合用来做什么

  • 根据 Diátaxis 框架编写这份 API 文档
  • 使用 Diátaxis 方法创建用户手册

安装 documentation-writer

npx skills add https://www.iskills.cc/skills/github/awesome-copilot/documentation-writer/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 documentation-writer 的用途与原始说明

浏览全部 Skill 指南