technical-writing

Installation
SKILL.md

Internal Technical Writing

Overview

Use this skill when the writing target is an internal技术方案、评审稿、架构说明、分享文稿,重点在于把背景、猜想、证据、抽象、实现影响面讲清楚。

这类写作更接近技术汇报,不是宣传稿,也不该写成散文。语气要平稳,判断要有来路,段落要能顺着问题往下读。

When to Use

  • 在写内部技术方案、设计说明、评审文档、分享稿
  • 在改一篇已经有内容、但文风过满、结论过快、证据不足的技术文章
  • 在解释代码、模块边界、架构演进、可观测性、评测方法
  • 在把聊天记录、讨论结论整理成可传播的技术文档

When not to use

Installs
3
GitHub Stars
9
First Seen
2 days ago