写开发教程用这Skill把前提讲明白

帮你编写技术教程和开发文档。

technical-writing 是面向开发者教程与文档的 Skill。它直接进入技术问题,解释如何实现以及为何这样选,用有位置说明的完整例子带读者走完过程。

读者复制代码之前,应知道依赖、输入和放在哪个文件,关键术语在使用前讲明白。只贴结果截图或说“剩下类似”,都不能帮助复现具体实现。

原文偏好连贯段落和有意义的小标题,但格式应服从交付任务,不能为了不列点让操作更难跟。例子要核运行与版本,清晰解释也不能替代实测;架构选择说明实际代价,不靠空泛形容词撑结论。本文没有编造亲测教程或运行结果。

分类:AI 与 Agent

来源仓库:mindrally/skills

适合用来做什么

  • 撰写一篇关于Docker入门的详细技术教程。
  • 为这个开源项目编写用户指南和常见问题解答。

安装 technical-writing

npx skills add https://www.iskills.cc/skills/mindrally/skills/technical-writing/SKILL.md

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

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

查看 technical-writing 的用途与原始说明

浏览全部 Skill 指南