| name | open-source-wording |
| description | MallBase 开源项目文案措辞规范;编写提交信息、文档、注释、备注或提示文案时使用。 |
开源项目文案措辞规范
适用范围
git commit 提交信息
- 文档、README、注释、提示文案、脚本输出
- PR 说明、变更备注、安装说明、错误提示
核心目标
面向开源项目输出文案时,保持中性、专业、包容,不使用带标签化、贬义、冒犯性或明显不适合公开传播的词汇。
强制规则
- 禁止使用带有用户分层、标签化或轻视意味的词汇,例如:
小白、傻瓜、懒人、弱智、低端 等。
- 禁止使用可能引发歧义的情绪化措辞,例如“闭眼用”“无脑改”“傻瓜式”。
- 面向用户的文案优先描述场景,不给用户贴标签。
- 面向提交信息的文案优先描述改动目标,不添加营销化或身份判断式描述。
推荐替代表达
小白友好 → 对新用户更友好 / 更易上手
傻瓜式部署 → 简化部署流程
无脑执行 → 按步骤执行
懒人配置 → 默认配置 / 零配置启动
自检清单
- 文案是否在描述功能或场景,而不是描述某类人。
- 文案是否适合直接出现在开源仓库首页、提交历史和发布说明中。
- 文案是否可以长期保留在公共历史中而不显得冒犯或不专业。