关于 zh-first
一项让项目产物优先使用简体中文的 Agent 技能,面向需要统一文档与注释语言的项目。它规定语言识别、术语表维护和表达规范,同时保留机器文本原样。
主要功能
- 01确定并记录项目主要语言
- 02规定面向人的产物使用简体中文
- 03代码注释统一使用简体中文
- 04补充领域术语表维护规则
- 05机器文本保持原样
适用场景
- 01统一项目文档和任务单语言
- 02为代码注释制定中文规范
- 03维护领域术语及代码标识符
- 04处理中文与机器字段混合的文档
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ykdz/ skills --skill zh-first安装后在 Claude Code 中输入/zh-first确认已加载。
附带文件agents/openai.yaml
详细介绍
来自项目 README简体中文优先
面向人类阅读的文本遵守以下规则。任务分类标签值、Status: 字段、命令和代码等机器文本保持原样。
项目语言
首次使用时确定项目主要语言,写入 docs/agents/language.md,此后沿用。文件不存在时,以用户会话语言与界面文案推断并建议补写。语言变更时更新该文件并记录架构决策。
- 架构决策记录、任务单、规格、代理任务说明、问卷、对齐记录、交接文档等面向人类阅读的技能产物使用简体中文
- 代码注释统一使用简体中文
项目领域术语
维护 domain-modeling 管理的项目领域词汇表 GLOSSARY.md 时,先读取该技能目录中的 GLOSSARY-FORMAT.md,再应用以下补充规则:
- 规范词用项目主要语言;简体中文项目用中文词
_Code_列出该概念的代码标识符:_Code_: order,在代码中涉及这个概念时使用的标识符必须为这里定义的词汇- 新增术语时,在同一次编辑中写入规范词和对应的
_Code_
示例:
**订单**:
用户下单后产生的一条购买记录。
_Code_: `order`
_Avoid_: 采购单, 交易单
表达方式
使用地道、简洁的简体中文,直接把事情说清楚,避免“不是...而是...”式铺垫、刻意排比和不必要的中英混用。润色不改变事实、限定或原有要求。
工程术语优先采用自然、准确的中文说法;需要保留英文时,首次出现作简短解释,后文保持称呼一致。
评论
支持 Markdown