guidelines-advisor

guidelines-advisor 技能總覽

guidelines-advisor 是一個以 Trail of Bits 的安全開發指南為核心打造的智能合約開發顧問。它能把程式碼庫轉化為可落地的工程建議：更清楚的文件、更好的架構決策、可升級性檢視、實作品質檢查、陷阱偵測、依賴性審查，以及測試覆蓋率建議。

誰適合使用 guidelines-advisor

如果你正在做 Solidity 或其他智能合約專案，而且需要的是結構化審查，而不是一段泛泛的提示詞回應，那就該用 guidelines-advisor。它特別適合技術寫作人員、協議工程師、稽核人員，以及正在準備內部規格或審查筆記的團隊。

guidelines-advisor 最擅長什麼

當你需要對儲存庫本身做引導式評估時，guidelines-advisor 的效果最好：每個模組在做什麼、哪些假設沒有寫清楚、升級模式是否有文件說明、測試或依賴是否還能再改善。它的重點不是改寫程式碼，而是產出足以支撐決策的系統分析。

什麼情境最適合

當你的實際工作是要用足夠嚴謹的方式，去說明、評估或記錄一個合約系統，以支援審查、交接或更安全的迭代時，就選 guidelines-advisor。如果你在做 guidelines-advisor for Technical Writing 這類工作流程，而且輸出必須是清楚英文、懂架構、又緊扣程式碼庫，那它會很合適。

如何使用 guidelines-advisor 技能

安裝並載入這個技能

安裝指令如下：

npx skills add trailofbits/skills --skill guidelines-advisor

在執行 guidelines-advisor install 時，請確認你指向的是 trailofbits/skills 儲存庫，以及 plugins/building-secure-contracts/skills/guidelines-advisor 路徑。安裝完成後，先從 SKILL.md 開始，再閱讀支援資源。

先讀這些檔案

想最快上手，先預覽：

• SKILL.md：範圍與工作流程
• resources/ASSESSMENT_AREAS.md：審查清單
• resources/DELIVERABLES.md：預期輸出
• resources/EXAMPLE_REPORT.md：完成版分析的格式

這些檔案會告訴你這個技能實際會產出什麼；這一點比儲存庫名稱本身更重要。

給這個技能完整的輸入

最好的 guidelines-advisor usage 一開始就要給出具體目標，而不是模糊請求。好的輸入通常會包含專案類型、變更內容、你想評估的項目，以及任何限制條件。

較好的提示詞：

Analyze this Solidity protocol repo for documentation gaps, upgradeability risks, dependency issues, and test coverage weaknesses. Focus on components that affect user funds and upgrade paths. Summarize findings in plain English and suggest concrete next steps.

較弱的提示詞：

Review this repo.

把它當流程使用，不要只用一次

實務上的 guidelines-advisor guide 可以這樣走：

1. 先請它做系統總覽。
2. 再要求架構、可升級性與實作審查。
3. 最後請它針對儲存庫的實際結構，指出文件缺口與測試改進。

如果儲存庫沒有升級機制，或沒有鏈下元件，請一開始就說明。這樣可以避免浪費分析資源，也能讓輸出更貼近現況。

guidelines-advisor 技能 FAQ

guidelines-advisor 只適用於 Solidity 嗎？

不是，但它對 Solidity 與智能合約系統最有價值。儲存庫中的核心指引是圍繞著安全合約開發而設計，所以非合約專案能得到的幫助通常會少一些。

它和一般提示詞有什麼不同？

一般提示詞也可以要求審查，但 guidelines-advisor 提供的是可重複使用的框架：探索、文件產出、架構分析、實作審查。這種結構能減少猜測，也讓不同儲存庫之間更容易比較輸出。

對初學者友善嗎？

如果你想要的是對合約程式碼庫的引導式說明，那答案是肯定的。你不需要事先背熟每條安全開發規則，但你需要一個真實的儲存庫和明確的目標。初學者在要求「白話文件加上主要風險」時，通常能得到最大價值。

什麼情況下不該使用它？

如果你只想要快速程式碼摘要、通用稽核清單，或是分析一個沒有明顯合約架構的專案，就不要用 guidelines-advisor。如果你要的是狹義的 bug 修補，而不是較廣泛的工程審查，它也不是最適合的選擇。

如何改善 guidelines-advisor 技能

先說清楚你要做的決策

要提升 guidelines-advisor skill 的輸出，最有效的方法就是先告訴它這次審查是為了什麼：新人上手、文件整理、升級規劃、安全強化，或發版準備。這個焦點會直接影響哪些發現最重要。

指出你在意儲存庫的哪些部分

強而有力的輸入會明確提到相關的合約、套件或流程，例如 proxy contracts、升級邏輯、費用路徑、代幣轉帳，或測試套件。如果你只想要 guidelines-advisor for Technical Writing，就直接說明，並要求它找出缺少的說明、模糊的假設，以及更好的 NatSpec 目標。

要求以證據為基礎的輸出

請它把發現事項連到檔案路徑、函式、模式，或缺漏的文件。這樣結果更容易驗證，也能減少空泛評論。例如：

Prioritize undocumented assumptions in contracts/, upgradeability issues in proxy flows, and missing test coverage around external calls.

第一輪之後再迭代

第一份輸出最適合作為地圖。你可以用它來提出更聚焦的追問：例如「把可升級性那一段展開」、「按檔案列出缺少的 NatSpec」，或「把這些發現轉成文件待辦清單」。這種工作流程通常比一次要求全部內容，能得到更銳利的結果。