SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-16 03:39

技能介绍

用途:撰写和编辑面向开发者的文档,让读者易于理解。核心是使用平实、以任务为导向、主动语态的叙述,配合可扫读的结构和规范的标点。该技能负责页面内的文字及其组织方式,不针对特定 Dev Portal,但与 portal-page-design(承载文字的组件)和 portal-branding(外观)配合使用。

主要能力:先提出两三个高影响问题(读者与任务、技术细节来源、可参照的现有页面、期望深度),再按任务选择结构。写作遵循第二人称、主动语态、现在时,前置重点,可扫读;建议时用“we recommend”并给出理由。文档需自包含:使用真实值或占位符,每个代码块一条命令,how-to 以验证步骤收尾。

使用方式:在页面内容文件中工作,可本地或仓库内进行;除非用户明确要求,不要向线上门户推送破坏性更改。记录 Konnect 资源时,通过 kong-konnect MCP 服务器从真实实体获取控制平面、服务、路由、规格等真实值,未连接则建议安装,否则向用户索取真实值或明确标注为占位符。Kong 内容遵循 Kong 文档风格指南,其他情况默认使用 Google 和 Microsoft 开发者风格指南。

适用场景:落地页、how-to、参考文档、API 或产品页、故障排查与 FAQ 等。

限制:不负责组件与布局(交给 portal-page-design),不负责外观(交给 portal-branding)。避免 LLM 痕迹,如破折号、空洞套话、模板化开头等。资料未提供具体收费、价格或平台支持信息。