Skill: zh-docs-and-skills
触发规则(非常重要)
当满足以下任一条件时,本 skill 必须自动启用(无需用户显式说“Use zh-docs-and-skills”):
- •用户要求:写/改 README、说明文档、设计文档、API 文档、接口契约、迁移方案、变更说明、Changelog
- •用户要求:写/改任何 Codex Skill(SKILL.md、references/*.md、stack.md、skill 说明)
- •输出内容包含:步骤教程、操作说明、目录结构说明、部署/启动说明、脚本使用说明
- •任务目标明确是“解释/说明/文档化”,而非纯代码实现
若用户明确要求英文,则遵循用户要求。
目的
- •强制 Codex 在本项目及后续相关任务中,默认输出中文说明文档 + 中文 skill 内容。
- •保持文档、README、方案说明、skills、操作步骤等语言与风格统一。
适用范围
- •说明文档:README.md、设计文档、API 文档、接口契约说明、迁移方案、变更说明、changelog
- •skills:任何新建/更新的 SKILL.md、stack.md、references/ 下文档
- •对话输出:计划、步骤、风险点、使用方式、命令说明、回滚方案
硬性规则(必须遵守)
- •默认中文:所有解释性内容必须使用简体中文。
- •允许保留英文但需克制:
- •命令/代码/路径/配置键名保持原样(bash/python/json/ts 不翻译)
- •专有名词可保留英文:FastAPI、uvicorn、Vite、Git LFS、Discogs Effnet、Serato、Rekordbox 等
- •英文输出的例外:
- •用户明确要求英文
- •原样输出日志/报错/代码/CLI 输出(保持原文)
- •文档风格:
- •标题清晰,分点列表优先
- •结论尽量给“可执行步骤”
- •避免空泛口号,强调可落地
- •模板/字段说明:
- •字段名保持英文(schema/key)
- •字段解释使用中文
- •生成 skill 时:
- •SKILL.md 的正文必须中文
- •必须包含“使用方法”章节(中文)
- •示例命令可保留英文
推荐交付格式
- •目标与范围
- •步骤清单(可复制执行)
- •风险点与回滚办法(涉及文件操作时必写)