適用於 Openclaw 的 Techwrite: 深度技術寫作工作流

Techwrite 是一款專業級文件引擎，旨在將複雜的技術概念轉化為面向開發者和利益相關者的、具有高精確度的實用文本。

mike47512

v1.0.0

Mar 28, 2026

安裝

基本資訊

Skill.md

安裝與下載

1. ClawHub CLI

從來源直接安裝技能的最快方式。


                  npx clawhub@latest install techwrite

2. 手動安裝

將技能資料夾複製到以下位置之一

全域模式

~/.openclaw/skills/

工作區

<project>/skills/

優先級：工作區 > 本地 > 內建

3. 提示詞安裝

將此提示詞複製到 OpenClaw 即可自動安裝。


                  請幫我使用 Clawhub 安裝 techwrite。如果尚未安裝 Clawhub，請先安裝（npm i -g clawhub）。

想要直接下載？

取得包含原生技能檔案的ZIP壓縮檔。

什麼是 Techwrite: 深度技術寫作工作流？

Techwrite 是為 AI 代理設計的專業化工作流，用於產出卓越的技術文件。它將重點從簡單的字數統計轉向清晰度、正確性和適當的深度。透過利用此 Openclaw Skills 資產，開發者可以確保其文件易於掃描、真實可靠，並能針對特定的讀者畫像量身定制，無論是起草內部 RFCs、公開 API 參考，還是複雜的遷移指南。

該技能執行嚴格的六階段生命週期，防止常見的文件陷阱，如模糊的代詞和隱含的假設。它優先考慮「待辦任務」（job-to-be-done），確保每一篇內容都能導向具體的成功結果，讓讀者能夠自信地執行操作或做出決策，而不會產生困惑。

Techwrite: 深度技術寫作工作流應用場景

為新功能起草詳盡的 API 參考和整合指南。
建立高風險的工程文件，如 RFCs (Request for Comments) 和 ADRs (Architecture Decision Records)。
編寫易於掃描的操作手冊（runbooks）、事後分析報告（postmortems）和開發者入職文件。
優化現有的技術頁面，以提高清晰度並消除文本中的技術債。
生成故障排除表格和邊緣案例文件，以減少支援工單。

Techwrite: 深度技術寫作工作流運作原理

對象與目標定義：該技能首先透過識別單一的主要讀者畫像和具體的「待辦任務」來確保內容聚焦。
大綱與範圍劃定：使用 BLUF (Bottom Line Up Front) 原則構建文件結構，並將章節映射到讀者的心理模型。
核心內容起草：生成精確的、主動語態的文本，同時避免使用模糊的形容詞，並在首次使用時定義技術術語。
範例與邊緣案例：整合最小完整程式碼片段和真實的失敗場景，以建立用戶信任。
清晰度審查：進行外科手術式的編輯，消除模糊代詞，並確保所有圖表和連結均可正常使用且易於訪問。
維護規劃：建立所有權和審查節奏，防止文件隨時間推移而失效。

Techwrite: 深度技術寫作工作流設定指南

要將 Techwrite 整合到您的環境中，請確保您已安裝 Openclaw Skills 執行器，然後將 techwrite 定義添加到您的代理程式庫中：

# 將 techwrite 技能添加到本地倉庫
openclaw skills add techwrite

# 在您的 AI IDE 或 CLI 中觸發工作流
/skill techwrite "為我們的新 auth 模組起草一份 API 指南"

Techwrite: 深度技術寫作工作流資料結構與分類體系

Techwrite 將文件數據組織成結構化的分類，以保持大型文件集的一致性：

屬性	描述	格式
成功語句	讀者的明確成果	字串
畫像	目標讀者 (例如：SRE, 新入職人員)	分類鍵
BLUF	結論先行 (Bottom Line Up Front) 摘要	Markdown 塊
程序化步驟	有編號的操作序列	有序列表
元數據	版本控制、所有者和最後審查日期	YAML Frontmatter