technical-writing

技術文檔編寫 (technical-writing) 技能為創作高品質、專業的軟體工程內容提供了結構化框架。專為開發者、QA 專業人員與技術主管設計，旨在溝通複雜概念、有效地報告錯誤或發表長篇技術文章。透過嚴格的核心原則，該技能確保文檔不僅具備可讀性，更能提供實質價值，成為團隊知識共享的催化劑。

• 基於原則的草擬：以價值為導向，透過具體證據佐證，並為快速掃描優化內容架構。

• 內容優化：利用內建的編輯檢查清單，刪除企業術語、模糊詞彙及不必要的綴詞。

• 目標導向溝通：針對開發者、QA/QE 與領導層規劃技術敘事，確保最佳傳達效果。

• 標準化格式：應用經證實的部落格文章、技術文件與教學架構，維持內容一致性。

• 無縫整合：透過 qe-quality-analyzer 與 qe-api-contract-validator 等代理工具，自動化文檔生成與品質審查流程。

• Markdown 高效應用：利用一致的文檔模板與記憶命名空間，實現長期的專案知識管理。

• 撰寫時應優先考慮讀者的收穫：閱讀此內容後能學到什麼或獲得什麼價值？

• 始終以真實世界的範例、指標、程式碼片段或日誌支援技術主張，而非使用抽象描述。

• 果斷刪除無助於提供洞見或目的的冗餘句子。

• 對於技術權衡持透明態度；承認每項架構決策皆有影響並誠實記錄。

• 使用提供的修改前後對照模式，將草稿轉化為具影響力的專業技術內容。

• 確保所有技術範例（特別是程式碼區塊）在發布前均經驗證，以維護資訊的可靠性。

• 考量受眾背景：開發者需要實作細節與程式碼；QA 團隊需要策略與啟發法；領導層則需要業務影響力與關鍵績效指標。