polish-technical-docs
Installation
SKILL.md
Polish Technical Docs
把技术原文改成专业、紧凑、结构化的文档。本质是编辑:只重排、精炼、删除原文的口水表达,不增不删实质技术信息,MUST NOT 编造事实、示例、版本号或新结论——技术含义、结论、代码逻辑与作者意图不变。
读者是资深开发者,成文是专业技术文档,非教程 / 非博客 / 非对话。最高优先级是杜绝口水文档——篇幅缩短不是副作用,是目标;成稿删掉任意一句都应该丢失技术信息。
Delete
- 填充语:
本文将介绍、接下来我们来看、你可以看到、其实这个东西就是、众所周知、值得一提的是。 - 叙事分支:
如果你用的是 Linux...、不熟悉 X 的话可以先...、遇到问题时可以尝试...。代码内的 if/else/switch 属代码逻辑,保留。 - 入门铺垫与背景科普:
在开始之前,先了解一下...、众所周知 X 是一种...、为了方便不熟悉的读者...。 - 跨段引用:
见上文、如前所述、同上表、见下文。每节把话说全,不让读者回翻。 - 状态标记:
TODO、待定、草稿、上一版、之前提到的。成稿即终稿。