用途
sharp-writing 是一套写作规范,覆盖所有散文与 Markdown 文本,面向人类读者和 AI 智能体两类受众。其目标是让文字简洁、精确、直击要点。技能建议在编写或编辑文档、README 等内容之前先阅读该规范。
主要能力与原则
- 先找本质:动笔前先找到想法的本质,把本质表述出来,并表述好。
- 精简优先:文字要简洁精确,直入主题,越少越好;使用易懂的语言,句子短而清晰;不注水、不堆砌。
- 尊重读者:不用强硬或命令式语气,不把读者当小孩,而是让重要内容更醒目;保持正式语域。
- 字斟句酌:选择能准确表达含义的词,优先常用词,只有更精确时才用复杂或技术性词汇。
- 正式但不僵硬:写完整句子,开头不省略;不用俚语、随意行话或表情符号。
结构规则
文本应像好代码一样组织:避免重复,像重构代码一样重构文本;一句一个想法,一段一个关注点;复杂想法拆成子想法并配小节标题;不把多个想法塞进一句,也不把多个关注点塞进一段,用冒号和破折号串联多个从句的句子应当拆分。写作还应呈现直达路径,而非寻找路径时的弯路。
风格规则
- 正面表述:说「是什么」,而非「不是什么」,避免让读者做反向理解。
- 删除否定式回声:如「X 是 A,不是 B」中 B 仅是 A 的缺失时,删掉否定的一半。
- 在最后一个事实处收尾:信息结束就结束,不写重述要点、说教或为所写内容辩解的收尾句。
- 仅在规则难以理解时举例,例子使用中性案例。
Markdown 约定
在 Markdown 文件中,每个散文段落写在一个物理行上,不按任何宽度换行。破折号(—)是两类受众之间主要的风格差异:对人类读者,破折号仅作为视觉分隔符使用;对 AI 智能体,破折号也可用于句子内部,但精确到位的句子很少需要它。
修改流程
写入文件的文本不是最终稿,应重读后自由编辑:重写、纠正、收紧。编辑即重写——把新内容融入既有句子,只有在没有句子能承载时才追加;好的编辑让文本与原来一样短或更短。
适用场景
适合文档、README 等说明性文字的撰写与编辑,也适合需要统一文风的 AI 智能体输出。
限制
该资料仅提供写作规范内容,未提供安装命令、调用方式、平台支持或收费信息,暂未提供。