关于 human-copywrite
一套从 2025 年 6 月《Apple Style Guide》提炼的写作规范,面向撰写各类用户可读文本的人,涵盖界面文案、文档、营销和本地化内容。
主要功能
- 01用户可读文本写作指导
- 02界面与开发者文档规则
- 03按主题组织的参考文件
- 04Apple 产品名称规范
- 05国际化写作指导
适用场景
- 01撰写界面标签和错误消息
- 02编写产品或开发者文档
- 03准备营销及本地化内容
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ pproenca/ dot-skills --skill human-copywrite安装后在 Claude Code 中输入/human-copywrite确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
gotchas.mdmetadata.jsonreferences/_sections.mda-z-lookup.mdabbreviations-and-acronyms.mdapple-features-software.mdapple-products.mdcapitalization.mdhyphenation-and-compounds.mdinternational-style.mdnumbers-and-dates.mdpunctuation.mdtechnical-notation.mdui-elements.mdunits-of-measure.mdvoice-and-tone.mdword-choice-and-confusables.md详细介绍
Human Copywrite
根据《Apple Style Guide》(2025 年 6 月)提炼的编辑风格和用法指南。只要你要撰写供人阅读的文本,就请使用本指南。
何时应用
只要输出内容供人阅读,就应使用这项技能。具体包括:
- UI 字符串和错误消息 — 按钮标签、对话框文本、空状态、引导文案。适用语气和 UI 词汇规则。
- 面向用户的文档 — 帮助文章、README、入门指南、教程。适用全部规则。
- 开发者文档 — API 参考、SDK 指南、供人阅读的代码注释。还需遵守技术标注规则。
- 营销文案 — 功能公告、落地页、发行说明。语气、大小写和产品名称规则至关重要。
- 本地化内容 — 任何需要翻译的内容。国际风格规则优先适用。
- 撰写有关 Apple 平台的内容 — 即使周边产品并非 Apple 产品,也要使用 Apple 偏好的形式来称呼 Apple 硬件和软件(iPhone、iPad、macOS、App Store)。
如果用户只是在编写没有面向用户字符串的代码,请跳过这项技能。如果用户在编写函数名或变量名,那不属于文案写作,而是命名,应遵循其他指南。
核心原则
以下原则贯穿各个部分。如有疑问,请遵循这些原则。
- 使用主动语态、现在时和第二人称。 你可以将 iPhone 连接到 Mac。 不要写成 iPhone 可以连接到 Mac。
- 具体胜于笼统。 选取“文件”>“存储”。 不要写成 使用菜单保存文件。
- 用简单词语,不用行话。 用 打开,而不是 激活。用 登录,而不是 进行身份验证(除非“身份验证”在技术上更准确)。
- 不要让产品成为用户操作的主语。 你可以使用 FileMaker Pro 创建数据库。 不要写成 FileMaker Pro 让你可以创建数据库。
- 屏幕上的项目是“出现”,不是“显示”。 设置助理会出现。 不要写成 设置助理会被显示。
- 不要复述代码的作用,而要说明原因。 适用于代码注释。
- 严格遵循产品名称的原样拼写。 使用 AirPods(不要写 Airpods)、iCloud(除非指付费档位,否则不要写 iCloud+)、Apple Pencil(不要写 the Apple pencil)。
- ≥10 的数字用数字表示;<10 的数字拼写出来 — 但有许多例外(numbers-and-dates.md)。
- 名词前的复合修饰语要加连字符;动词后不加 — user-friendly app,the app is user friendly。
- 在代码中,绝不把函数名当作动词使用。 写 在两个目录上运行
ls,不要写ls两个目录。
如何使用
始终先阅读此 SKILL.md,然后加载与当前任务相关的主题文件。若只需查询单个术语,请转到 references/a-z-lookup.md,并按其中的指引找到主题文件。
主题文件
| 文件 | 何时阅读 |
|---|---|
| voice-and-tone.md | 撰写面向用户的文案时。大多数文案决策都在这里。 |
| punctuation.md | 决定如何使用长破折号、短破折号、省略号、逗号、冒号、撇号和引号时。 |
| capitalization.md | 撰写标题、名称、按钮标签或专有名词相关术语时。 |
| hyphenation-and-compounds.md | 处理复合修饰语、e- 和 re- 前缀,以及 user-friendly 与 user friendly 等写法时。 |
| numbers-and-dates.md | 撰写日期、时间、范围、序数、百分比、分数、年代、2D、4K、24/7 时。 |
| units-of-measure.md | 引用 GB、MHz、mm、英寸等单位时。包含完整的 SI 单位/符号表。 |
| word-choice-and-confusables.md | 区分 affect/effect、backup/back up、login/log in、OK、email、online 等词语时。 |
| abbreviations-and-acronyms.md | 确定何时写出全称、如何处理文件类型、复数形式和冠词时。包含行业缩写(URL、ISP、JPEG 等)。 |
| ui-elements.md | 查找按钮、菜单、表单、弹出框、侧边栏和控件的用语时。 |
| apple-products.md | 查找 Apple 硬件名称时:iPhone、iPad、Mac、MacBook、Apple Watch、AirPods、Apple Pencil 等。 |
| apple-features-software.md | 查找 macOS、iOS、iCloud、Apple Music、Siri、AirDrop、Apple Intelligence、Genmoji 及所有 Apple 软件/服务/功能时。 |
| technical-notation.md | 撰写开发者文档时:代码字体、语法说明、占位符。 |
| international-style.md | 撰写本地化或国际化内容时:ISO 国家/货币/语言代码、ISO 8601 日期、电话号码。 |
A-Z 索引
查询单个词语(“backup 和 back up 应该怎么写?”)时,请打开 references/a-z-lookup.md,并按照其中的指引前往包含该条目的主题文件。
注意事项
请参阅 gotchas.md。有一条适用范围说明值得提前了解:本技能在摄取时有意排除了源文件中的“包容性写作”章节(代词、以人为本与以身份为本的语言,以及替代 blacklist/whitelist 和 master/slave 的说法)。
来源
《Apple Style Guide》,2025 年 6 月(243 页)。按主题提炼并重新整理,以便按需加载。转载内容均保留原文。该指南的网页版位于 https://support.apple.com/guide/applestyleguide/welcome/web。