用途:为编写贴近 Apple 官方风格的技术文档与交互式教程提供写作规范,覆盖语气、句式、大小写、教学结构、用词禁忌与视觉素材标准。
主要能力:
- 严格句首大写规则:标题、章节、表格表头、图解文字标签、导航标签只大写首字母、专有名词(Swift、Xcode、Core ML、SwiftUI、SwiftData)和标准缩写(API、HTTP、URL、UI),禁止 Title Case。
- 教学语气:面向读者的第二人称 you/you'll,避免被动语态、第三人称“开发者”和 we/us;反浮夸原则,直说代码行为,不用学术或营销腔。
- 教程步骤三句式结构:第一句祈使动作、第二句原理背景、第三句可观察反馈;每步最多 1–3 句。
- 教学结构模式:先做 5 分钟单文件微原型,再拆分为多文件架构;每个 @Section 限 3–5 步;每个里程碑配专门收尾页,回顾要点并给出后续链接。
- 禁用词汇:缩小词(simply、just、easily、obviously 等)、营销超级词(blazing-fast、magical 等)、学术行话;禁止“In this step, we will…”式元叙述。
- 视觉规范:hero 图必须是运行中应用或真机 mockup,不可放架构图;截图留 ≥32px 安全边距,提供 @2x 资源并适配深色外观。
- 矢量图规范:文本卡片宽度按 (最长行字符数 × 10) + 32px 计算,使用 text-anchor="middle" 与 <tspan> 堆叠、每行不超过 24 字符;使用 Cupertino 配色(如浅色画布 #FFFFFF、卡片 #F5F5F7、强调色 #0071E3),并提供 ~dark 深色版资源。
使用方式:所属技能包为 peterfriese/swift-docc-skills 下的 swift-docc-techwriting;撰写或审校 DocC 文档时参照其 references/sentence-case-guide.md 与 references/step-anatomy-and-prohibitions.md。
适用场景:编写或审校 Apple 平台技术文档、DocC 教程与图解。
限制:本资料未提供安装命令、收费方式与平台支持信息,暂未提供;矢量图几何公式与 SVG 标记细节需查阅配套技能 swift-docc-diagrams。