SuperAPI AI 工具集

adev-writing-guide

写作与研究

查看项目

更新于 10-16 01:15

技能介绍

用途:为 Angular 官方文档(adev)提供写作规范,适用于在 adev/src/content 目录下撰写与维护文档内容。

主要能力: 一、Google 技术写作规范。语气友好专业、面向全球读者、以用户任务为先;使用第二人称、主动语态、标准美式英语;条件从句前置;首次出现时定义术语并保持术语一致;一句一个观点。格式上标题用句首大写,有序列表用于步骤、无序列表用于并列项、描述列表用于术语定义,使用牛津逗号,代码相关文本用代码字体,UI 元素加粗,日期用无歧义格式。图片需清晰并配说明;代码示例须正确可构建,注释侧重原因而非显而易见的内容。引用优先级为项目自身规范、Google 开发者文档风格指南、Merriam-Webster、芝加哥手册、微软写作风格指南。 二、Angular 文档专属约定。代码块语言标识:含内联模板的 TypeScript 用 angular-ts,Angular 模板用 angular-html,普通 TypeScript 用 ts,普通 HTML 用 html,终端用 shell 或 bash,图表用 mermaid。代码块可在语言标识后加大括号属性:header="标题"、linenums、highlight="[1, 3-5]"、hideCopy、prefer、avoid。更高级功能用 <docs-code> 组件,支持 path、header、language、linenums、highlight、diff、visibleLines、region、preview、hideCode;多文件示例用 <docs-code-multifile> 包裹多个 <docs-code>。提示块用关键词加冒号:NOTE、TIP、IMPORTANT、CRITICAL、TODO、QUESTION、SUMMARY、TLDR、HELPFUL。自定义组件包括卡片 <docs-card>(须在 <docs-card-container> 内)、<docs-callout>、药丸 <docs-pill>(须在 <docs-pill-row> 内)、步骤 <docs-step>(须在 <docs-workflow> 内)、标签页 <docs-tab>(须在 <docs-tab-group> 内)、视频 <docs-video>。图片用标准 Markdown,可在 URL 后加 #small、#medium 控制尺寸,并可用 {loading: 'lazy'} 懒加载。标题用 #、##、### 并保持层级不跳级。

使用方式与限制:本技能为写作规范指南,资料未提供安装命令或调用方式;具体项目规范若存在(如 CONTRIBUTING.md)应优先遵循。资料未说明收费、平台与效果信息。