使用文件 / 簡介

從這裡開始。

認識 Noryn 的工作流程、權限界線,以及讓代理輔助工作更容易審查的習慣。

快速入門

在熟悉的程式庫中,從一項小而可驗證的任務開始。第一個目標,是釐清工作界線。

開發者預覽版: 這些指令描述規劃中的 Noryn 命令列介面。本預覽未包含可執行程式、安裝程式、帳號或正式 AI 服務端點。

1. 準備工作區

在本機 Git 程式庫中開啟終端機,檢查工作目錄並留意尚未提交的內容。將憑證與無關的私人檔案排除在任務範圍之外。

從唯讀計畫開始
cd your-project
git status
noryn plan "說明搜尋請求的處理方式"

2. 指定一個成果

描述預期行為與界線。「為搜尋加入 250 毫秒防抖,並保留鍵盤導覽」比「改善搜尋」更容易評估。

3. 審查交付內容

檢視建議的程式差異與檢查報告。在提交任何內容前,確認行為符合需求。

工作階段流程

Noryn 工作階段是圍繞單一任務展開的對話。脈絡、決策、編輯與檢查結果保持連結,讓你能追溯變更背後的推理。

  1. 理解: 找出相關檔案、慣例與預期行為。
  2. 計畫: 確認範圍,並讓假設清楚可見。
  3. 行動: 核准必要的編輯與指令。
  4. 驗證: 執行約定的檢查,並檢視結果。
  5. 審查: 將最終變更與原始需求對照。

若任務範圍擴大,請先停下來調整計畫。代理不應把無關的改進視為小範圍修正的一部分。

程式庫脈絡

Noryn 規劃中的脈絡流程,從專案指示、相關原始碼與鄰近測試開始,目標是整理出有用的工作資料,避免不加選擇地複製整個程式庫。

如果任務依賴不易發現的細節,請明確指出檔案,並說明它是要遵循的範例,還是需要修改的實作。

指出重要脈絡
noryn plan "從 src/server.ts 追蹤驗證流程到工作階段儲存區"

排除的內容

使用 .norynignore 檔案標示不應納入脈絡的內容。忽略規則能協助限定範圍,但不能取代作業系統權限或機密管理。

.norynignore
.env
.env.*
secrets/
customer-exports/
*.pem

專案指示

在程式庫根目錄新增 NORYN.md ,說明適用於各項任務的重要慣例。指示應具體、簡短,並對應可驗證的行為。

NORYN.md
# 工作準則

- 重用既有的驗證輔助函式。
- 保留對外回應的資料結構。
- 手動編輯的變更中,不要包含自動產生的檔案。
- 執行受影響模組的測試。
- 回報所有無法執行的檢查。

說明怎樣才算妥善完成。若某個目錄需要不同規則,請清楚指出目錄與例外。隨著程式庫演進,一併審查程式碼與專案指示。

權限與核准

權限區分代理可以讀取什麼、在哪裡編輯,以及執行哪些指令。請從完成任務所需的最低權限開始。

唯讀

探索與規劃不代表授權編輯檔案或執行指令。可使用此模式理解專案,或討論建議做法。

工作區編輯

計畫準備好後,再核准選定工作區內的編輯。若要變更範圍外的檔案,應重新確認授權。

指令執行

指令可能執行任意專案程式碼、存取網路或修改檔案。核准前,請閱讀指令及其目的。熟悉的指令名稱,並不能證明其實作安全。

發布、部署、帳號變更與破壞性操作,都需要明確授權。專案指示本身不會授予這些權限。

指令參考

以下參考內容描述規劃中的指令介面。引號內的文字,是傳給代理的任務提示。

規劃中的 Noryn 命令列指令
指令 用途
noryn plan 探索並提出做法,不編輯檔案。
noryn run 在已核准的權限內開始編輯任務。
noryn review 摘要目前的程式變更與已記錄的檢查。
noryn resume 繼續最近一次本機工作階段。
noryn check 執行已設定且獲准的專案檢查。
常用指令
noryn plan "整理身分驗證流程"
noryn run "為搜尋頁面加入空白狀態"
noryn review
noryn resume

審查程式變更

像審查隊友的程式碼一樣閱讀變更。先關注行為,再看範圍、檢查品質與實作細節。

  • 成果是否解決了提出的問題?
  • 是否影響無關的檔案或行為?
  • 測試是否涵蓋失敗情境,而非只是重複實作步驟?
  • 是否考量錯誤、空白與權限遭拒的狀態?
  • 是否有宣稱的成果缺少支持證據?
檢查工作目錄
git diff --stat
git diff
git status

代理的摘要是查閱證據的索引,無法取代對實際程式差異的審查。

疑難排解

代理似乎忽略了專案慣例

在 NORYN.md 中明確記錄慣例,並指出一個具代表性的檔案。要求再次編輯前,先確認範例已納入目前脈絡。

某項檢查無法執行

閱讀回報的失敗原因。缺少憑證、服務無法使用與權限限制,都與測試斷言失敗不同。尚未執行的檢查,應持續標示為未驗證。

任務範圍不斷擴大

暫停工作階段,重申預期成果、指出應保持不變的檔案,並要求修訂計畫後再繼續。

規劃中的命令列指令無法使用

本預覽未提供 Noryn 可執行程式。文件是產品概念的參考資料,目前沒有可用的安裝指令。

資料與本機歷程

規劃中的代理流程會在本機保留工作階段紀錄。未來若連接託管模型,將傳送處理任務所需的選定脈絡;連線前必須揭露供應商與資料保留設定。

此網站本身不會傳送表單內容或搜尋查詢。瀏覽器允許時,僅以 localStorage 儲存顯示主題偏好。詢問草稿只保留在記憶體中,除非你選擇下載。

關於本預覽的資料處理方式,請參閱 隱私權聲明 。