Content Guidelines 文案规范
组件内置文案与示例文案统一、专业、易懂;与 i18n 协同(文案规则约束 key 的默认值与对外建议)。
原则
- 准确清晰:避免歧义与口语化;功能名一致(同一概念全库同名)。
- 简洁:去冗余,能短则短;按钮用「动词 / 动宾」(保存、删除、新建)。
- 一致:大小写、标点、术语统一;中文用全角标点,英文用半角。
- 友好克制:错误 / 警告文案说明「发生了什么 + 怎么办」,不指责用户。
- 大小写 / 标点规范:英文按句首大写;中文标题不加句号。
- 数字与单位:遵循 i18n 的
Intl格式,不在文案里写死。
各类文案规则
| 场景 | 规范 |
|---|---|
| 按钮 | 动词优先:保存 / 取消 / 删除;危险操作明确(永久删除) |
| 空状态 | 说明为何为空 + 下一步动作 |
| 错误 | 原因 + 解决建议,避免「出错了」这类无效信息 |
| 占位符 | 提示输入内容,不替代 label |
| 确认弹窗 | 标题陈述动作,正文说明后果,按钮回显动作(删除 / 取消) |
落地
- 内置默认文案集中在
@chenzy-design/locale的各语言包,统一审校。 - 提供「文案 checklist」给作者手册,组件作者与文档示例都要遵守。
- 危险 / 不可逆操作的文案要求在组件 SPEC 的「文案」章节单列。
验收标准
- 全库内置文案符合本规范(审校通过)。
- 同一概念全库术语一致。
- 文档示例文案符合规范。