用途:面向博客文章、文档、教程和技术文章的技术写作指导,强调基于自己在生产环境中的真实经验来写,只写亲身做过的事,探索性内容需明确说明。
主要能力:提供以价值开篇、用具体示例/代码/数字而非空话、便于扫读的结构化排版、删减冗余、诚实呈现利弊等原则。给出博客文章结构模板:标题给出具体承诺,开头2-3段包含钩子(问题或洞见)、背景与读者将获得的收获,正文3-5节每节一个清晰观点并用示例/代码/数据支撑,结尾给出关键结论与可执行动作。归纳可删减词汇(basically、actually、probably、leverage、synergy、paradigm、very、really、quite 等)与避免的行为。提供按受众区分的写法:面向开发者以代码或具体问题开篇并讨论取舍;面向 QA/QE 从测试挑战、策略与风险评估入手;面向管理层以业务影响与指标开篇。附发布前编辑清单,包括标题具体、开篇能30秒内抓住人、主张有示例支撑、代码示例经过验证、结论清晰等。还给出前后改写对照示例,如将笼统表述改为“我们把探索性测试移入 sprint 计划,QE 在故事梳理阶段与开发结对,在写代码前识别风险”。
用法:作为写作规范或清单使用,可直接用于撰写与修改文档。文中提供智能体集成的 TypeScript 代码片段,通过 Task 调用生成与审查文档,例如 const docs = await Task("Generate Docs", { source: 'src/services/PaymentService.ts', format: 'markdown', includeExamples: true }, "qe-quality-analyzer"); 并建议用记忆命名空间 aqe/technical-writing/ 存放生成文档、评审结果与模板,以及通过 FleetManager.coordinate 组织 qe-quality-analyzer 与 qe-api-contract-validator 等智能体协作。
适用场景:技术博客、API 与产品文档、教程、技术文章,以及需要按不同受众调整侧重点的写作任务。
限制:资料未提供具体安装命令、收费与价格、平台支持、效果数据等信息。所有示例数字均为资料中的示范,不代表通用效果。