SuperAPI AI 工具集

qe-technical-writing

写作与研究

查看项目

更新于 10-16 03:48

技能介绍

用途:该技能用于撰写清晰、有吸引力的技术内容,适用于博客文章、文档、教程与技术文章。核心主张是从真实生产经验出发写作,只写自己实际做过的事,若仍处于探索阶段应明确说明。

主要能力:提供一套写作原则与结构模板。原则包括以价值开篇(读者能学到或获得什么)、展示而非讲述(具体示例、代码、数字)、按可扫读方式组织(标题、加粗、短段落)、 ruthless 删减(每句都要有价值)、诚实说明取舍。博客结构为:标题(具体承诺)、开头二至三段(问题或洞见、意义、读者将学到什么)、三至五个正文小节(每节一个明确观点,用示例、代码或数据支撑)、结尾(一到两句要点,加可执行动作)。工具还提供快速参考卡,对比“差/好”写法,列出应删减的措辞(hedge 词、企业套话、多余限定词),并给出编辑检查清单,发布前核对标题、开头吸引力、论断证据、代码正确性、要点清晰度等。

分受众写法:面向开发者时以代码或具体问题开篇,展示实现细节并讨论取舍;面向 QA/QE 时从测试挑战入手,展示策略与风险评估;面向管理层时以业务影响开篇,使用关键指标并简明处理技术细节。文档中提供了前后改写示例,说明如何将笼统表述改为具体做法与量化结果。

使用方式:资料给出 TypeScript 形式的智能体集成示例,用 Task 生成或评审文档,例如以 source、format、includeExamples 参数生成文档,以 files、checkClarity、checkCodeExamples 参数评审文档,指定代理 qe-quality-analyzer;亦可配合 qe-api-contract-validator 做 API 文档准确性校验。技能使用记忆命名空间 aqe/technical-writing/,下含 generated-docs、reviews、templates 目录;还可通过 FleetManager.coordinate 以 documentation 策略、sequential 拓扑协调代理。相关技能包括 bug-reporting-excellence 与 code-review-quality。

适用场景:技术博客、项目文档、教程、技术文章,以及需要按受众调整表达的技术沟通。

限制:资料未提供具体收费、价格、平台支持范围或可量化效果,均暂未提供;示例代码需按实际环境验证后使用。