写技术文档先分读者任务的Skill

按Diátaxis框架创建技术文档。

documentation 是按读者需求组织技术文档的 Skill。本文介绍 mcollina/skills 的版本,它用 Diátaxis 把学习教程、操作指南、事实参考和原理解释分开。

第一次做项目的人需要能跟着完成的步骤;有经验的人通常只想解决眼前问题。查参数则要迅速找到类型、默认值与限制,不必先读一段故事。

不同内容可相互链接,避免教程反复被背景解释打断。但分类不是禁用表格或示例的规定,关键是让每页服务一个主要任务,术语与版本保持一致。

适合整理难找、难跟的文档。验收应按读者任务安排:能否做完、查到事实或理解原因。本文未测试真实读者;原文“30秒查到事实”是检验目标,不是成稿后自动获得的效果。

分类:研究学习

来源仓库:mcollina/skills

适合用来做什么

  • 按照 Diátaxis 框架编写一份关于机器学习的技术教程。
  • 审查这篇操作指南的结构,并提出改进建议。

安装 documentation

npx skills add https://www.iskills.cc/skills/mcollina/skills/documentation/SKILL.md

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

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

查看 documentation 的用途与原始说明

浏览全部 Skill 指南