LuluSkill
中文
語言
English

語言與主題僅儲存在此瀏覽器。

從目標開始
← 回到寫作

寫作

Technical Writer

十一個技術寫作技能,建立在同一份核心風格指南上:先講結論、每項陳述都能追溯到來源、每個事實只寫在一個地方,並列出禁用的寫法。專門技能涵蓋設計文件與 RFC、架構決策紀錄(ADR)、變更紀錄與版本說明、操作手冊、議題追蹤工作單、事後檢討報告、為既有程式碼庫補寫文件、流程圖、API 與資料格式參考文件,以及審閱他人的技術文字。適合希望文件維持一致、可查證寫作風格的工程師與技術文件撰寫者。

  • 技術寫作
  • 程式碼文件
GitHub 星數:29(2026-10-13 取得)

來源:riekelt/technical-writer · 固定提交 099d31b

在 GitHub 查看原始碼

LuluSkill 收錄這個專案,是為了讓你找得到它。收錄不代表安全審查或推薦,這個頁面也不會替你安裝或執行任何東西。

編輯導讀

先選技術文件類型,再決定措辭

操作手冊、決策紀錄與介面契約有不同要求。結構只有在結論依據所提供證據時才有用。

這是 LuluSkill 自己對這個專案的解讀,不是它 README 的摘要。 約 3 分鐘讀完

這份導讀是 LuluSkill 對「這個專案什麼情況適合」所做的判斷,依據的是上方所列的固定版本。它不是作者的文件、不是安全審查,也不是推薦。LuluSkill 並未為了寫這份導讀而安裝、執行或測試該專案;只有在這筆收錄項目仍然指向導讀撰寫時所依據的提交時,導讀才會顯示。

什麼情況適合這個專案

特定技術文件需要一致結構與可追溯結論時,可考慮此集合。說明文件在嚴格寫作慣例下,分類決策紀錄、操作手冊與契約等專長;先選文件類型才有用。

什麼情況應選別的方法

不要只是為消除不一致,就把規範政策改成符合有問題的實作。事故報告也要區分觀察事件與假設。整齊結構不能補上缺少的操作證據、決策或核准歷史。

準備什麼,以及預期得到什麼

提供文件類型、讀者、來源事實及已核准決策。預期得到符合目的且清楚標示缺口的草稿。每項持續維護的事實應有明確位置,避免後續更新產生互相矛盾的複本。

工具、權限與使用邊界

提供的文件可能已足夠起草。檢查或寫入專案需要限定存取,各環境專用助理或指令需要相容設定。操作手冊列出命令,不代表有權對正式服務執行。

取捨與替代方法

一份已充分理解的文件,可能用小範本就足夠。多種文件需要有紀律的一致性時,此集合更有價值。成本是讓寫作慣例符合實際義務,而非讓格式凌駕內容。

一個小型驗收練習

建議練習:從一項已知失敗及復原程序起草操作手冊。分別檢查觸發條件、前提、驗證及升級處理。若指令編造權限、包含未說明的破壞步驟,或復原主張沒有記錄支持,就應拒絕。

來源、版本與實際閱讀範圍

已閱讀固定版本說明文件的介紹、寫作慣例原則與文件專長清單。未評估個別範本、命令或實際操作程序。 LuluSkill 沒有安裝或執行這個專案;上述練習是供讀者使用的建議檢查,並非實測成果。

如何使用這筆收錄項目

LuluSkill 只發布說明與來源連結。技能本身留在原作者的儲存庫中,這裡不會替你安裝、複製或執行任何東西。

  1. 閱讀這項技能能幫上什麼忙 上方的摘要說明這個專案是為哪一種工作而寫的。如果那不是你手上的工作,這筆收錄項目大概不適合你。
  2. 開啟原始來源,並依照作者自己的說明操作 連向原始專案的連結會開啟作者的頁面。安裝步驟與複製說明放在那個頁面,而不是這裡。
  3. 在相容的 AI 助理中使用它 這類技能通常是在能讀取你電腦上資料夾的 AI 助理裡使用。哪些助理支援它們由作者決定,請先查看他們的頁面。

適合什麼人

已經確定要完成這一件事,並且願意照著作者安裝步驟操作的人。這裡不假設你會寫程式,但這筆收錄項目無法判斷這個專案是否適合你。

開始之前

你需要一個支援技能的 AI 助理,並且要在自己的電腦上照著別人寫的說明操作。執行任何東西之前,請先讀過那些說明。

最後會得到什麼

作者那個專案會產出的東西。LuluSkill 不會執行它,因此這個頁面無法承諾任何成果、檔案或品質水準。

通常在哪裡使用

這類專案通常在支援技能的 AI 助理中使用,例如 AI 程式開發助理。作者的儲存庫會說明它是為哪些助理而寫;LuluSkill 尚未在任何助理上測試過它。

檢查的版本

來源檢查所依據的提交: 099d31b

這個提交之後的儲存庫變更未經檢查。

授權

MIT,依據來源儲存庫在所列提交中的授權檔案。使用或複製這個專案之前,請先查看儲存庫的授權條款。

僅供收錄參考

LuluSkill 只收錄這個專案,不會託管、下載或執行它的程式碼。

這個頁面不包含的內容

專案的檔案與安裝步驟都留在它自己的儲存庫中。LuluSkill 沒有對這個專案做過安全測試,也沒有確認它適用於哪些 AI 助理。

回報問題或要求下架

權利人與使用者都可以回報此頁面在授權、署名、安全或內容正確性方面的問題。我們會在 48 小時內回覆,並將每一件請求記錄在審查紀錄中。

將開啟你的電子郵件程式。你也可以直接寫信至 contact@luluskill.com,並附上此頁面的網址。