technical-writing

规范中文技术文档写作风格的AI技能

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:technical-writing。
它的用途是:规范中文技术文档写作风格的AI技能
完整的 Skill 内容见:https://321skill.com/skills/technical-writing/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“使用technical-writing技能,帮我把这段关于新缓存架构的群聊讨论整理成一份设计评审稿。” 它会按照“背景→现状→猜想→论证”的结构重新组织内容,剔除口语化和不严谨的表达,并使用规范的标点和列表呈现,最终生成一份可直接用于团队评审的技术文档。

介绍

此技能旨在解决中文技术写作中常见的文风问题,如过度营销化、结论先行、证据不足、结构松散等。它通过一套严格的写作约束,引导AI产出符合内部技术汇报要求的文档,确保内容客观、结构清晰、论证严谨。

使用时,在支持的AI Agent(如Claude Code、Cursor等)中调用technical-writing技能,然后提交需要撰写或修改的技术文档草稿、讨论记录或写作需求即可。技能会自动应用其内置的规则进行内容组织和风格校准。

它非常适合需要频繁产出或评审内部技术文档的工程师、技术负责人和文档工程师。无论是撰写设计文档、复盘报告,还是将零散的会议记录整理成文,都能借助此技能提升文档的专业性和可读性。

建议在撰写初稿或修改他人文档时使用。对于完全从零开始的创作,可以先让AI自由发挥一个草稿,再使用此技能进行规范和润色,效果更佳。注意,它不负责技术内容的正确性,只专注于写作风格的约束与提升。

核心特点

与通用写作辅助技能不同,它深度聚焦于中文技术写作的特定场景,提供从标点符号(如统一使用「」引号)、禁用词汇黑名单到文章主线结构的全套约束规则,旨在彻底剥离营销和散文气质,让文档回归技术本质。

注意事项

不适用于撰写UI文案、产品营销稿、面向外部用户的帮助文档或机械的API参考文档。

常见问题

这个技能支持哪些AI工具?

支持Claude Code、Cursor、Windsurf、GitHub Copilot、Cline等主流AI Agent运行时。

能用来写英文技术文档吗?

不能,该技能专为中文技术写作设计,其核心约束(如标点、句法)均针对中文语境。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/technical-writing/raw/index.md 读取 technical-writing 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。