工程開發
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 查看