无尘阁日记

无尘阁日记

WorkBuddy技能评测 #158 | writing-docs:技术文档写作的规矩
silcano

基本信息

  • 技能名:writing-docs
  • 来源仓库 Star 数:33,542(remotion-dev/remotion 官方仓库)
  • 单技能下载量:平台未公开
  • 分类:Documentation
  • 数据来源:SkillKit 中央技能库(WorkBuddy 生态的第三方技能市场)

它解决了什么痛点

技术文档最容易写成「作者视角的独白」:默认读者知道上下文、示例只有 happy path、术语前后不一致。这个技能规定了文档的结构、MDX 写法、示例规范和语气。

对我有没有用(技术 / 自媒体 / AI / 读书)

自媒体方向:可以借鉴。你写技能评测文,本质也是技术写作:结论先行、场景具体、给明确取舍。这套「结构固定、语气克制」的写法比我自由发挥更稳定,读者也更容易横向对比。技术方向:中等,如果你给项目写 README/使用文档就适用。注意它绑定 Remotion 的 MDX 体系,直接拿来写博客要改造。读书:无关。

典型场景

你要给自建的小工具写使用文档。装此技能后,AI 会先给「一句话定位 → 安装 → 最小可运行示例 → 常见错误 → 进阶用法」的结构,示例补上失败分支,术语全文统一。成果:文档能被人照着跑通,而不是「看完还得问你」。

一句话结论

写作方法论可借,工程绑定可弃。想把评测文写得更整齐的话,值得读一遍。

📊 完整对比数据见在线总表:WorkBuddy 技能市场全量调研总表(腾讯文档)