writing-style 是一份面向技术沟通的写作风格指南,来源于 umputun/cc-thingz。它规定了在特定技术场景中应当采用的表达方式。
用途 该指南适用于 GitHub/GitLab issue 评论、PR/MR 描述与评论、代码评审评论、提交信息、工单中的技术讨论以及团队内部沟通。
例外情况 README.md、官方文档(用户指南、API 文档、教程)、公开博客文章、面向公众的发布说明,以及任何面向普通受众的公开可见内容,应改用规范英语:完整句子、正确大小写、不使用缩写、专业语气。
使用前的用户覆盖检查 在应用本指南前,需检查用户是否已定义自己的写作风格规则:查看项目级和用户级 CLAUDE.md 中是否有写作风格相关章节(如 writing style、communication style、tone、comment style 等标题);检查用户自有技能目录中是否定义了自定义 writing-style 技能。若存在用户自定义规则,则完全遵循用户规则,不应用本指南;仅在用户规则存在可补充的空白时,才提及本指南的存在。若不存在用户自定义规则,则将本指南作为默认规则应用。
核心原则 简洁直接:直入主题,跳过填充短语和不必要的上下文,简短回应若已传达完整信息即可,省略“希望这对你有帮助”“有问题请告诉我”之类的话。 诚实直接的反馈:直接表达观点而非含糊其辞;公开表达不确定,如“I'm not sure”“I can't see how”;不人为软化批评;在合适时质疑设计决策。 问题—解决方案结构:简明陈述问题,说明做了什么,跳过戏剧化铺垫;多个问题时使用编号列表。 技术精确:包含精确引用,如文件路径、行号、commit 哈希;链接到具体 commit 或 issue;标识符使用反引号行内代码;代码片段使用三反引号代码块;假定读者具备技术背景,可自由使用领域术语。
代码评审评论 直接指出问题;尽可能附带代码建议替代方案;公开质疑设计决策;引用具体行号。
问答 尽可能直接给出是/否,随后简短解释;不要重复问题。
应避免的 AI 典型用语 填充短语(直接删除):It's important to note that...、It's worth mentioning...、In order to...(直接用 to)、plays a crucial role in、at the end of the day、that being said、moving forward、in terms of。 过度使用的 AI 词汇(改用更简单说法):comprehensive 改为 full/complete;robust 改为 solid/reliable;leverage 改为 use;utilize 改为 use;facilitate 改为 help/enable;optimal 改为 best;seamless 直接跳过;streamline 改为 simplify。 抽象名词(改为动词):the implementation of 改为 implemented;make a decision 改为 decide;provide assistance 改为 help;perform an analysis 改为 analyze。 对冲措辞(改为直接表达):I think maybe we could consider... 直接陈述观点;It would seem that... 直接陈述事实;Perhaps it might be worth... 直接建议。 冗余过渡(少用):Furthermore 改为 also 或直接继续;Additionally 改为 also 或省略;Moreover 通常不必要;In conclusion 直接作结。 元评论(删除):This approach works by... 直接描述其作用;The benefit of this is... 直接说明好处;What this means is... 直接说出来。
不应做的事 不要使用:Thanks in advance、Hope this helps、Let me know if you have any questions、I appreciate your patience、Looking forward to hearing from you、Best regards(在 issue 评论中)、I hope you're doing well;避免过度礼貌的对冲、企业套话和营销语言。
Markdown 格式 行内代码使用反引号;代码块使用三反引号并标注语言;链接使用文本形式;粗体用于强调;斜体用于旁注;列表使用 - 或 1.。
应用总结 简洁——词越少越好;直接——除非确实不确定,否则不对冲;诚实——不知道或不赞同就直说;精确——引用 commit、文件、行号;避免 AI 腔——不用 comprehensive、leverage、facilitate、in order to;跳过客套——技术评论中不加寒暄和署名告别。该风格仅适用于技术沟通(工单、PR、代码评审、提交),README.md、公开文档和博客文章应使用规范英语。