工程开发
technical-writing avatar

technical-writing

根据实际工程经验撰写清晰、专业的技术文档、博客文章与教学指南,优先考虑价值传递与可执行的见解。

简介

技术写作技能专为需要有效沟通复杂技术概念的工程师与质量工程实践者所设计。它超越了一般的写作建议,转而专注于“展示,而非诉说”的方法论,确保每一份内容(无论是技术文档、API 指南还是架构深度分析)都能提供可衡量的价值。此技能强制执行结构化的写作框架,强调以读者为中心的内容,精准地回答“为什么”与“如何做”,并对权衡利弊保持透明。

  • 基于原则的草拟:专注于以价值为导向,消除如“leverage”或“synergy”等企业术语,并优先使用具体的、数据支持的声明,而非空洞的叙述。

  • 结构化格式:实施标准化的博客与文档架构,包括吸引读者的开场白、清晰的可扫描标题与明确的重点总结。

  • 针对受众的客制化:根据目标读者调整技术深度,无论是为开发人员提供代码密集的实作细节、为质量工程师提供风险评估启发式法则,还是为领导层提供高层级的商业影响指标。

  • 自动化审查周期:与 qe-quality-analyzer 及 qe-api-contract-validator 代理整合,确保技术内容保持技术准确性并与代码库保持一致。

  • 严谨的编辑:在发布前应用严格的清单检查,包括清晰度审计、代码正确性验证与精简修剪。

  • 当您需要编写 README、项目维基、内部事后检讨或对外技术文章时,请使用此技能。

  • 预期输出将要求清晰、基于证据的输入;若您正在编写关于测试策略的内容,请提供如错误侦测率或效能改进等指标。

  • 此技能旨在架起深度技术工作与可存取知识之间的桥梁,有效地将工程成果转化为高实用性、可共享的内容。

  • 请避免将此技能用于创意小说或缺乏技术实质的营销文案;它专为专业的、基于经验的技术沟通而优化。

仓库统计

Star 数
329
Fork 数
65
Open Issue 数
4
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 06:09
在 GitHub 查看