technical-writing

技术文档编写 (technical-writing) 技能为创作高质量、专业的软件工程内容提供了结构化框架。专为开发者、QA 专业人员与技术主管设计，旨在沟通复杂概念、有效地报告错误或发表长篇技术文章。通过严格的核心原则，该技能确保文档不仅具备可读性，更能提供实质价值，成为团队知识共享的催化剂。

• 基于原则的草拟：以价值为导向，通过具体证据佐证，并为快速扫描优化内容架构。

• 内容优化：利用内建的编辑检查清单，删除企业术语、模糊词汇及不必要的缀词。

• 目标导向沟通：针对开发者、QA/QE 与领导层规划技术叙事，确保最佳传达效果。

• 标准化格式：应用经证实的博客文章、技术文件与教程架构，维持内容一致性。

• 无缝整合：通过 qe-quality-analyzer 与 qe-api-contract-validator 等代理工具，自动化文档生成与质量审查流程。

• Markdown 高效应用：利用一致的文档模板与记忆命名空间，实现长期的项目知识管理。

• 撰写时应优先考虑读者的收获：阅读此内容后能学到什么或获得什么价值？

• 始终以真实世界的范例、指标、代码片段或日志支撑技术主张，而非使用抽象描述。

• 果断删除无助于提供洞见或目的的冗余句子。

• 对于技术权衡持透明态度；承认每项架构决策皆有影响并诚实记录。

• 使用提供的修改前后对照模式，将草稿转化为具影响力的专业技术内容。

• 确保所有技术范例（特别是代码块）在发布前均经验证，以维护信息的可靠性。

• 考量受众背景：开发者需要实作细节与代码；QA 团队需要策略与启发法；领导层则需要业务影响力与关键绩效指标。