用途:让技术文档只有一种读法——一个概念用一个词、一句话讲一个主题、每个动作有明确主体、需求用固定词。规则来自ASD-STE100第1部分九个章节;英文规则保留对软件文本重要的STE语法规则,中文规则去掉纯英文语法并补充中文技术写作常见问题(隐藏动词如“进行”“加以”、长前置修饰、缺主语、指代不清)。两种语言共用一套规则编号,完整规则见references/rules-en.md与references/rules-zh.md。
适用范围:仅限技术文档,即读者用来理解系统、执行操作或做技术决策的文本,包括设计文档、README、API参考、运行手册、故障排查与迁移指南、提交信息、PR描述、代码注释、错误信息和界面帮助文本。不适用于营销或创意文本(营销文案、品牌故事、博客与社交帖子、发布公告、演讲、小说),这类文本依赖节奏、情感和修辞,套用规则会使其失去目的。混合文档(如发布说明)只对技术部分应用规则。
语言处理:按文档自身语言应用对应规则,而非按对话语言判断。中文文档含英文术语时用中文规则;双语文档各自应用本语言规则。翻译不属于本技能范围,用户要求翻译时先翻译再对目标语言应用规则。
工作流程:先确认文本属于技术文档;查找项目术语表和风格指南,项目约定优先于本规则;按规则摘要撰写或改写,规则不清时查阅对应语言规则文件;运行机械检查python3 <skill dir>/scripts/check.py <file>(可加--lang en或--lang zh强制语言),该脚本只列出需查看之处而非判定;按references/output-template.md交付。
规则摘要:硬规则全部遵守,软规则遵守约80%且每次违反需有理由。涵盖用词(一词一义、一词一义、使用术语表、避免模糊词)、名词短语(修饰语数量、名词连用、修饰标记)、动词(不把动词藏进名词、主动语态、简单时态、固定需求词must/must not/should/should not/can/need not或应/不应/宜/不宜/可/不必)、句子(一句一主题、明确主体、代词指代唯一、显示连接、三项以上用列表)、程序(编号步骤、祈使动词开头、条件在前、步骤长度限制)、描述性写作(结论先行、段落主题、长度限制、测量数字带条件与日期、区分已完成与计划)、警告(警告在步骤前、先指令后风险、每警告一个风险、两级警告)、标点数字长度(ASCII或全角标点、统一引号、数字与单位空格、范围用“–”或“to”“到”、日期不可误读、计数方式)、写作实践(术语单一形式、代码名用反引号、官方产品名与缩写定义、避免习语填充营销词)。
限制与注意:规则控制措辞而非内容,须保留原文全部事实、条件、例外和疑问;改写不是审计,保留作者主张强度,只删空泛强化词,缺失证据在报告中列出而非内联要求证明;内联占位符仅在读者缺该事实无法完成任务时使用,写“[TBD: …]”或“[待补:……]”,不得填入猜测或看似合理的数字;引文、代码、命令输出、专有名词和用户原话保持原样;保留章节、标题和链接结构。内容过时需重建用hai-rewrite-doc,判断文档是否真实或与代码一致用hai-audit-docs,仅Markdown布局问题用readme-beautifier,跨模块概念命名用hai-naming,撰写或塑造PRD用hai-prd。常见错误包括对营销文案套用规则、把每个未测量主张变成内联TBD、占位符填猜测值、因句子变短而删去注意事项或风险、为遵守模糊词规则而改动正确技术术语、把脚本命中的每条软规则都当作缺陷。