包實(shí)戰(zhàn):為 OpenAI Codex 搭建 Agent-First 倉(cāng)庫(kù)模板與 SOP 工作流)
【免費(fèi)下載鏈接】learn-harness-engineeringHarness engineering beginner tutorial, from 0 to 1項(xiàng)目地址https://gitcode.com/gh_mirrors/le/learn-harness-engineering點(diǎn)擊查看免費(fèi)下載導(dǎo)讀本指南圍繞 learn-harness-engineering 倉(cāng)庫(kù)中的docs/ja/resources/openai-advanced高級(jí)包展開(kāi)它把 OpenAI 文章 Harness engineering: leveraging Codex in an agent-first world 所描述的、更具觀點(diǎn)傾向opinionated的倉(cāng)庫(kù)結(jié)構(gòu)打包為可直接復(fù)制的模板。讀者將掌握何時(shí)從最小 harness 升級(jí)到高級(jí)包、如何按順序?qū)雛epo-template/目錄、如何把AGENTS.md當(dāng)作路由層而非百科全書(shū)寫(xiě)、以及如何用 4 份 SOP 建立可強(qiáng)制、可復(fù)現(xiàn)的 Agent 工作流。1. 高級(jí)包的定位最小 harness 不夠用時(shí)的升級(jí)路徑learn-harness-engineering 項(xiàng)目整體遵循漸進(jìn)式披露progressive disclosure理念先以最小 harness 起步等倉(cāng)庫(kù)規(guī)模與協(xié)作復(fù)雜度增長(zhǎng)后再引入更厚重的結(jié)構(gòu)。docs/ja/resources/openai-advanced/index.md明確給出了從最小包升級(jí)到高級(jí)包的判斷標(biāo)準(zhǔn)——當(dāng)你的倉(cāng)庫(kù)出現(xiàn)以下需求時(shí)就該啟用本包需要一個(gè)短小精悍的路由型AGENTS.md而非巨型指令文件需要倉(cāng)庫(kù)內(nèi)的持久化系統(tǒng)記錄文檔system of record需要**活躍與已完成的執(zhí)行計(jì)劃exec-plans**目錄需要明確的產(chǎn)品、可靠性、安全、前端策略文件需要按產(chǎn)品領(lǐng)域與架構(gòu)分層進(jìn)行質(zhì)量評(píng)分需要面向模型的參考資料文件夾需要架構(gòu)、知識(shí)捕獲、運(yùn)行時(shí)驗(yàn)證的標(biāo)準(zhǔn)操作程序SOP。這與倉(cāng)庫(kù)內(nèi) lecture-04-why-one-giant-instruction-file-fails 所講的巨型單文件指令必然失敗一脈相承高級(jí)包的解決方案不是寫(xiě)更長(zhǎng)指令而是把知識(shí)拆進(jìn)多個(gè)深度鏈接的文檔由入口文件負(fù)責(zé)路由。2. 模板總覽repo-template 目錄結(jié)構(gòu)與職責(zé)高級(jí)包的核心資產(chǎn)位于docs/ja/resources/openai-advanced/repo-template/index.md它是一份可直接拷入實(shí)際倉(cāng)庫(kù)的起始骨架。整體結(jié)構(gòu)如下摘自原文檔AGENTS.md ARCHITECTURE.md docs/ ├── design-docs/ │ ├── index.md │ └── core-beliefs.md ├── exec-plans/ │ ├── active/ │ ├── completed/ │ └── tech-debt-tracker.md ├── generated/ │ └── db-schema.md ├── product-specs/ │ ├── index.md │ └── new-user-onboarding.md ├── references/ │ ├── design-system-reference-llms.txt │ ├── nixpacks-llms.txt │ └── uv-llms.txt ├── DESIGN.md ├── FRONTEND.md ├── PLANS.md ├── PRODUCT_SENSE.md ├── QUALITY_SCORE.md ├── RELIABILITY.md └── SECURITY.md模板的目錄設(shè)計(jì)各司其職從倉(cāng)庫(kù)實(shí)際文件如docs/ja/resources/openai-advanced/repo-template/docs/PLANS.md、QUALITY_SCORE.md、RELIABILITY.md、SECURITY.md等可以看出它優(yōu)化的目標(biāo)是持久的倉(cāng)庫(kù)本地上下文Agent 每次會(huì)話(huà)都能從倉(cāng)庫(kù)文件恢復(fù)狀態(tài)不依賴(lài)聊天歷史漸進(jìn)式披露入口文件只給地圖細(xì)節(jié)通過(guò)鏈接逐層展開(kāi)顯式的計(jì)劃生命周期exec-plans/active/、exec-plans/completed/與tech-debt-tracker.md形成閉環(huán)隨時(shí)間追蹤質(zhì)量QUALITY_SCORE.md讓倉(cāng)庫(kù)在變強(qiáng)還是變?nèi)蹩闪炕瘜?duì) Agent 與人類(lèi)都友好的邊界每個(gè)文件有明確主題避免互相吞噬職責(zé)。3. 導(dǎo)入步驟5 步把模板落地到自己的倉(cāng)庫(kù)docs/ja/resources/openai-advanced/repo-template/index.md給出了明確的復(fù)制順序copy order復(fù)制入口層把AGENTS.md與ARCHITECTURE.md復(fù)制到倉(cāng)庫(kù)根目錄復(fù)制文檔樹(shù)整個(gè)docs/目錄樹(shù)整體復(fù)制先填充三份策略文檔優(yōu)先填寫(xiě)docs/PRODUCT_SENSE.md、docs/QUALITY_SCORE.md、docs/RELIABILITY.md——它們是質(zhì)量與可靠性追蹤的起點(diǎn)建立第一個(gè)活躍計(jì)劃在docs/exec-plans/active/中加入第一份進(jìn)行中的執(zhí)行計(jì)劃保持入口簡(jiǎn)短所有入口文件保持精煉把細(xì)節(jié)導(dǎo)向鏈接文檔。原文檔還特別強(qiáng)調(diào)模板中的所有文件都應(yīng)視為起點(diǎn)而不是終點(diǎn)。占位符[domain-a]、[command]、[產(chǎn)品名に置き換え]之類(lèi)、示例與示例命令必須在投入真實(shí)項(xiàng)目前替換成實(shí)際內(nèi)容。高級(jí)包雖然故意帶有觀點(diǎn)但應(yīng)當(dāng)適配你的項(xiàng)目而不是盲目照搬。4. 入口層把 AGENTS.md 寫(xiě)成路由層而非百科全書(shū)倉(cāng)庫(kù)內(nèi)的docs/ja/resources/openai-advanced/repo-template/AGENTS.md是整套高級(jí)包設(shè)計(jì)哲學(xué)的最佳示范。它開(kāi)篇就申明這個(gè)文件要短作為指向系統(tǒng)記錄文檔的路由層而不是巨型指令轉(zhuǎn)儲(chǔ)。文件本體由四部分組成。4.1 啟動(dòng)工作流Startup Workflow在改動(dòng)任何代碼之前Agent 必須按固定順序執(zhí)行用pwd確認(rèn)倉(cāng)庫(kù)根目錄讀ARCHITECTURE.md確認(rèn)系統(tǒng)地圖與嚴(yán)格依賴(lài)規(guī)則讀docs/QUALITY_SCORE.md判斷哪個(gè)領(lǐng)域或?qū)幼畋∪踝xdocs/PLANS.md打開(kāi)正在進(jìn)行的活躍計(jì)劃讀docs/product-specs/中相關(guān)的產(chǎn)品規(guī)格執(zhí)行本倉(cāng)庫(kù)標(biāo)準(zhǔn)的引導(dǎo)bootstrap與驗(yàn)證路徑若基線驗(yàn)證失敗先修復(fù)基線再增加新范圍。這條路徑把初始化固化成了每個(gè)會(huì)話(huà)的強(qiáng)制動(dòng)作呼應(yīng)倉(cāng)庫(kù) lecture-06-why-initialization-needs-its-own-phase 的核心觀點(diǎn)——初始化必須是一個(gè)獨(dú)立階段而不是可有可無(wú)的鋪墊。4.2 路由映射Routing Map路由表把每一個(gè)關(guān)注點(diǎn)映射到唯一文檔避免哪都寫(xiě)了等于哪都沒(méi)寫(xiě)ARCHITECTURE.md領(lǐng)域地圖、分層模型、依賴(lài)規(guī)則docs/design-docs/index.md設(shè)計(jì)決策與核心信念docs/product-specs/index.md當(dāng)前產(chǎn)品行為與驗(yàn)收標(biāo)準(zhǔn)docs/PLANS.md計(jì)劃生命周期與執(zhí)行計(jì)劃策略docs/QUALITY_SCORE.md產(chǎn)品領(lǐng)域與層的健康度docs/RELIABILITY.md運(yùn)行時(shí)信號(hào)、基準(zhǔn)測(cè)試與重啟預(yù)期docs/SECURITY.md密鑰、沙箱、數(shù)據(jù)與外部動(dòng)作規(guī)則docs/FRONTEND.mdUI 約束、設(shè)計(jì)系統(tǒng)規(guī)則、可訪問(wèn)性檢查。4.3 工作契約Working Contract一次只處理一個(gè)有邊界的計(jì)劃或功能切片僅憑閱讀代碼不能標(biāo)記為完成必須有可運(yùn)行的證據(jù)改變行為的同時(shí)必須在同一會(huì)話(huà)內(nèi)更新對(duì)應(yīng)的產(chǎn)品、計(jì)劃或可靠性文檔若反復(fù)收到同類(lèi)評(píng)審反饋把口頭解釋升級(jí)為機(jī)械規(guī)則、檢查或 lint而不是再次在聊天中解釋生成產(chǎn)物放docs/generated/來(lái)源參考放docs/references/優(yōu)先新增小而新的文檔而不是讓本文件膨脹。4.4 完成定義與會(huì)話(huà)收尾Definition of Done / End of Session變更只有在全部滿(mǎn)足時(shí)才視為完成目標(biāo)行為已實(shí)現(xiàn)、必要驗(yàn)證已實(shí)際運(yùn)行、證據(jù)已鏈接到相關(guān)計(jì)劃或質(zhì)量文檔、受影響文檔已更新、倉(cāng)庫(kù)能從標(biāo)準(zhǔn)啟動(dòng)路徑干凈重啟。會(huì)話(huà)結(jié)束前還有一套強(qiáng)制收尾動(dòng)作更新活躍執(zhí)行計(jì)劃領(lǐng)域或?qū)佑袑?shí)質(zhì)變化則更新docs/QUALITY_SCORE.md有推遲的債務(wù)則記入docs/exec-plans/tech-debt-tracker.md適時(shí)把結(jié)束的計(jì)劃移入docs/exec-plans/completed/最終讓倉(cāng)庫(kù)停留在下一步動(dòng)作清晰、可重啟的狀態(tài)。這與倉(cāng)庫(kù) lecture-12-why-every-session-must-leave-a-clean-state 的主張完全一致。5. 架構(gòu)層用 ARCHITECTURE.md 固化系統(tǒng)地圖docs/ja/resources/openai-advanced/repo-template/ARCHITECTURE.md定義了系統(tǒng)最頂層的地圖文件包含六個(gè)板塊系統(tǒng)構(gòu)成產(chǎn)品名、主用戶(hù)工作流、運(yùn)行時(shí)表面desktop / web / cli / services / workers、產(chǎn)品行為的可信來(lái)源docs/product-specs/領(lǐng)域地圖表格列出每個(gè)領(lǐng)域的目的、主入口點(diǎn)與關(guān)聯(lián)規(guī)格層模型使用固定方向模型Types - Config - Repo - Service - Runtime - UI防止 Agent 即興發(fā)明臨時(shí)架構(gòu)橫切關(guān)注點(diǎn)應(yīng)通過(guò)顯式的 provider 或 adapter 邊界加入而不是直接跨層嚴(yán)格依賴(lài)規(guī)則下層不得依賴(lài)上層UI 不得繞過(guò) Runtime/Service 契約數(shù)據(jù)訪問(wèn)必須經(jīng)由 Repository 或等價(jià)適配器共享工具類(lèi)保持通用、不得堆積領(lǐng)域邏輯新依賴(lài)需在計(jì)劃或設(shè)計(jì)文檔中給出理由橫切接口表格列出日志與追蹤、認(rèn)證、外部 API、特性開(kāi)關(guān)各自的批準(zhǔn)邊界與約束變更清單觸碰架構(gòu)相關(guān)代碼時(shí)更新領(lǐng)域地圖/邊界 → 更新docs/design-docs/→ 對(duì)可機(jī)械強(qiáng)制的規(guī)則增加可執(zhí)行檢查。分層邊界與禁止跨層依賴(lài)的要求與倉(cāng)庫(kù) lecture-14-graph-engineering 以及 SOP 中的 layered-domain-architecture.md 形成呼應(yīng)架構(gòu)不再靠 Agent 自覺(jué)而是靠文檔 可執(zhí)行檢查雙重約束。6. 策略文檔族計(jì)劃、質(zhì)量、可靠性與安全如何配合高級(jí)包把一次性寫(xiě)不完的策略拆成一組聚焦文檔模板目錄中實(shí)際存在并定義了以下角色內(nèi)容分別摘自倉(cāng)庫(kù)中的對(duì)應(yīng)文件6.1 PLANS.md執(zhí)行計(jì)劃的生命周期PLANS.md 定義了計(jì)劃從創(chuàng)建到歸檔的規(guī)則。需要?jiǎng)?chuàng)建執(zhí)行計(jì)劃的場(chǎng)景跨會(huì)話(huà)的工作、涉及多個(gè)子系統(tǒng)的改動(dòng)、存在非平凡驗(yàn)證或發(fā)布風(fēng)險(xiǎn)、依賴(lài)尚未決斷的決策。計(jì)劃存放位置分三處exec-plans/active/正在推進(jìn)、exec-plans/completed/為未來(lái) Agent 保留上下文、tech-debt-tracker.md推遲的工作與跟進(jìn)。每份計(jì)劃必須包含目的、范圍與范圍外、驗(yàn)證路徑、風(fēng)險(xiǎn)與阻塞、進(jìn)度日志、未決事項(xiàng)。運(yùn)行規(guī)則強(qiáng)調(diào)計(jì)劃是活的文檔——隨進(jìn)展持續(xù)更新、方向被決策改變時(shí)記入計(jì)劃、結(jié)束的計(jì)劃移入completed/。6.2 QUALITY_SCORE.md讓倉(cāng)庫(kù)健康度可追蹤QUALITY_SCORE.md 用四個(gè)評(píng)分等級(jí)追蹤倉(cāng)庫(kù)隨時(shí)間的強(qiáng)弱變化A已驗(yàn)證、可讀、穩(wěn)定、邊界被強(qiáng)制、B有輕微缺口但可用、C部分可用、有明顯混亂或不穩(wěn)定、D損壞、不安全或結(jié)構(gòu)不清。它按產(chǎn)品領(lǐng)域評(píng)估、Agent 可讀性、測(cè)試穩(wěn)定性、主要缺口、最后更新與架構(gòu)層Types/Services/Runtime/UI 的邊界強(qiáng)制與可讀性分別打分并提供基準(zhǔn)快照表日期、harness 變體、完成率、重試次數(shù)、評(píng)審前缺陷數(shù)與簡(jiǎn)化日志刪除的組件、結(jié)果、決定讓簡(jiǎn)化是否值得也有據(jù)可查。這與倉(cāng)庫(kù) lecture-11-why-observability-belongs-inside-the-harness 中的 evaluator-rubric.md 思路一致給評(píng)估設(shè)定顯式標(biāo)準(zhǔn)。6.3 RELIABILITY.md如何證明系統(tǒng)可重啟RELIABILITY.md 定義系統(tǒng)健康且可重啟的證明方式標(biāo)準(zhǔn)路徑bootstrap / 驗(yàn)證 / 啟動(dòng) / 運(yùn)行時(shí)調(diào)試命令、必需運(yùn)行時(shí)信號(hào)結(jié)構(gòu)化日志、健康檢查、慢路徑 trace、用戶(hù)可見(jiàn)錯(cuò)誤狀態(tài)、黃金旅程golden journeys清單以及四條硬性規(guī)則——無(wú)法干凈重啟的功能不算完成運(yùn)行時(shí)故障應(yīng)能由倉(cāng)庫(kù)本地信號(hào)診斷反復(fù)出現(xiàn)的故障模式要固化為基準(zhǔn)或護(hù)欄清理本身就是可靠性的一部分。6.4 SECURITY.md讓 Agent 不必猜測(cè)安全規(guī)則SECURITY.md 規(guī)定 Agent 不得自行猜測(cè)的安全底線密鑰不得硬編碼、需文檔化受批準(zhǔn)的密鑰加載路徑、日志與截圖中的令牌/API 密鑰/個(gè)人數(shù)據(jù)必須脫敏外部?jī)?nèi)容在驗(yàn)證前一律視為不可信記錄允許的 fetch/執(zhí)行邊界對(duì)提示注入與命令注入風(fēng)險(xiǎn)建立護(hù)欄列出需要顯式批準(zhǔn)的外部動(dòng)作、默認(rèn)禁止的生產(chǎn)/破壞性命令優(yōu)先沙箱安全的工作流新依賴(lài)需在活躍計(jì)劃中給出理由安全敏感變更必須有顯式驗(yàn)證步驟重復(fù)出現(xiàn)的評(píng)審意見(jiàn)應(yīng)固化為檢查而非隱式知識(shí)。6.5 其余策略文件FRONTEND / PRODUCT_SENSE / DESIGN模板還包含docs/FRONTEND.mdUI 約束、設(shè)計(jì)系統(tǒng)規(guī)則與可訪問(wèn)性檢查、docs/PRODUCT_SENSE.md產(chǎn)品感知與產(chǎn)品領(lǐng)域判斷與docs/DESIGN.md設(shè)計(jì)文檔入口。從 AGENTS.md 的路由映射可以看到FRONTEND.md被明確指定為 UI 相關(guān)規(guī)則的唯一來(lái)源它們與docs/design-docs/core-beliefs.md核心信念、docs/product-specs/new-user-onboarding.md產(chǎn)品規(guī)格示例一起構(gòu)成策略可路由、細(xì)節(jié)可追溯的文檔體系。7. SOP 庫(kù)把文章圖表演化成可執(zhí)行的運(yùn)行手冊(cè)高級(jí)包的第二個(gè)資產(chǎn)是 sops/ 目錄它把文章中的運(yùn)行模式轉(zhuǎn)化為 4 份可遵循或可適配的逐步執(zhí)行劇本layered-domain-architecture.md建立顯式分層與橫切關(guān)注點(diǎn)邊界encode-knowledge-into-repo.md把散落在聊天、文檔與記憶中的隱性知識(shí)遷移為倉(cāng)庫(kù)內(nèi)文件observability-feedback-loop.md為 Agent 提供日志、指標(biāo)、trace 與可復(fù)現(xiàn)的調(diào)試回路chrome-devtools-validation-loop.md用瀏覽器自動(dòng)化與快照驗(yàn)證 UI 行為直到變干凈clean。使用方法是四步循環(huán)按當(dāng)前瓶頸選擇匹配的 SOP → 用其清單補(bǔ)齊缺失產(chǎn)物或工具 → 把產(chǎn)出的規(guī)則編碼進(jìn)已復(fù)制的repo-template/文檔 → 把反復(fù)出現(xiàn)的評(píng)審意見(jiàn)轉(zhuǎn)化為檢查、腳本或護(hù)欄。sops 目錄的定位聲明也很關(guān)鍵這些 SOP 不是讓人盲目照做而是為了讓 harness 更可讀、更可強(qiáng)制、更可復(fù)現(xiàn)。8. 設(shè)計(jì)原則總結(jié)與適配建議高級(jí)包在docs/ja/resources/openai-advanced/index.md末尾歸納了五條設(shè)計(jì)原則可作為評(píng)估任何 Agent 工作區(qū)的判斷標(biāo)尺短入口、深鏈接的文檔入口文件只路由不灌輸把倉(cāng)庫(kù)當(dāng)作系統(tǒng)記錄system of record知識(shí)必須落盤(pán)機(jī)械檢查勝過(guò)記憶規(guī)則能用 lint/檢查強(qiáng)制就別靠提示詞約束計(jì)劃與質(zhì)量歷史放在代碼旁上下文就近可得清理與簡(jiǎn)化是一等公民簡(jiǎn)化不是事后補(bǔ)課而是常規(guī)工作的一部分。最后提醒高級(jí)包故意帶有觀點(diǎn)使用時(shí)應(yīng)結(jié)合自身項(xiàng)目裁剪——它給出的是可復(fù)制、可強(qiáng)制、可復(fù)現(xiàn)的 Agent-first 倉(cāng)庫(kù)范式而不是一份放之四海而皆準(zhǔn)的教條。若想進(jìn)一步動(dòng)手實(shí)踐可結(jié)合倉(cāng)庫(kù)的 projects 系列項(xiàng)目如 project-02-agent-readable-workspace 與 project-06-runtime-observability-and-debugging在真實(shí)任務(wù)中驗(yàn)證這套高級(jí)包的效果。贊分享【免費(fèi)下載鏈接】learn-harness-engineeringHarness engineering beginner tutorial, from 0 to 1項(xiàng)目地址https://gitcode.com/gh_mirrors/le/learn-harness-engineering點(diǎn)擊查看免費(fèi)下載相關(guān)推薦learn-harness-engineering 高級(jí) OpenAI Pack面向 Codex 的 agent-first 倉(cāng)庫(kù)模板與 SOP 實(shí)戰(zhàn)指南learn harness engineering 高級(jí) OpenAI Pack面向 Codex 的 agent first 倉(cāng)庫(kù)模板與 SOP 實(shí)戰(zhàn)指南 本用 AGENTS.md 搭建 Agent-First 倉(cāng)庫(kù)learn-harness-engineering 的 OpenAI 高級(jí)路由模板實(shí)戰(zhàn)指南用 AGENTS.md 搭建 Agent First 倉(cāng)庫(kù)learn harness engineering 的 OpenAI 高級(jí)路由模板實(shí)戰(zhàn)指南 導(dǎo)讀 本Agent-First 倉(cāng)庫(kù)的四大標(biāo)準(zhǔn)操作流程SOPlearn-harness-engineering 中的 OpenAI Advanced SOP 實(shí)戰(zhàn)手冊(cè)Agent First 倉(cāng)庫(kù)的四大標(biāo)準(zhǔn)操作流程SOPlearn harness engineering 中的 OpenAI Advanced SOP 實(shí)戰(zhàn)創(chuàng)作聲明:本文部分內(nèi)容由AI輔助生成(AIGC),僅供參考