technical-writing

用途

该技能用于指导技术内容的写作，帮助作者从真实经验出发，写出清晰、有吸引力的技术内容。适用场景包括撰写博客文章、文档、教程或技术文章。

主要能力

技能围绕以下核心写作原则展开：

以价值开篇：先告诉读者能学到或获得什么。
展示而非说教：使用具体示例、代码和数字。
为浏览而结构化：使用标题、加粗、短段落。
果断删减：每一句话都必须有其价值。
诚实说明取舍：不回避方案的代价与局限。

技能提供博客文章结构模板：标题（具体承诺）、开头（2-3段，包含钩子、背景、承诺）、正文（3-5节，每节一个清晰观点，配示例/代码/数据）、结尾（1-2句关键要点和读者可采取的行动）。

技能还包含快速参考卡，以表格形式对比“差”与“好”的写法，例如：以价值开篇（差：“In today's landscape...” 好：“Here's how we cut bugs 60%”）、展示而非说教（差：“We improved testing” 好：“Bug detection: 12→47 per sprint”）、具体化（差：“Performance improved” 好：“Response time: 2.3s→180ms”）、诚实取舍（差：“This approach is best” 好：“TDD slowed velocity 20%, reduced bugs 75%”）。

技能列出应删除的词汇，如 basically、actually、probably（模糊限定词），leverage、synergy、paradigm（企业套话），very、really、quite（不必要的修饰），it should be noted that（直接陈述即可）。

使用方式

技能提供分众写作建议：

面向开发者：以代码或具体问题开篇，展示实现细节，讨论取舍与替代方案，链接仓库或示例。
面向 QA/QE：从测试挑战入手，展示策略而非仅工具，包含风险评估，提供可调整的启发式方法。
面向领导层：以业务影响开篇，使用关键指标，将技术与结果关联，保持技术细节简洁。

技能提供发布前编辑清单：标题是否承诺具体内容、开头能否在30秒内吸引读者、论点是否有示例支撑、是否删去所有不必要词汇、代码示例是否经过测试且正确、要点是否清晰、是否愿意发给尊敬的同事。

技能还给出改写示例，例如将“We decided to implement a more comprehensive testing strategy that would allow us to catch bugs earlier in the development lifecycle.”改写为“We moved exploratory testing into sprint planning. QE now pairs with devs during story refinement, identifying risks before code is written.”

智能体集成

技能提供 TypeScript 代码示例，用于从代码生成文档和评审文档质量：

// Generate documentation from code
const docs = await Task("Generate Docs", {
  source: 'src/services/PaymentService.ts',
  format: 'markdown',
  includeExamples: true
}, "qe-quality-analyzer");

// Review documentation quality
const review = await Task("Review Docs", {
  files: ['README.md', 'docs/api.md'],
  checkClarity: true,
  checkCodeExamples: true
}, "qe-quality-analyzer");

技能说明智能体协调提示，内存命名空间为 aqe/technical-writing/，包含 generated-docs/*（自动生成的文档）、reviews/*（文档评审发现）、templates/*（可复用文档模板）。

技能提供舰队协调代码示例：

const docsFleet = await FleetManager.coordinate({
  strategy: 'documentation',
  agents: [
    'qe-quality-analyzer',         // Generate and review
    'qe-api-contract-validator'    // API doc accuracy
  ],
  topology: 'sequential'
});

适用场景与限制

该技能适用于撰写博客文章、文档、教程和技术文章，尤其强调只写自己在生产环境中实践过的内容；如果处于探索阶段，应明确说明。技能本身不涉及具体收费、价格或平台信息，这些内容暂未提供。

技能介绍

用途

主要能力

使用方式

智能体集成

相关技能

适用场景与限制