Karatasi ya kumbukumbu

Karatasi ya kudanganya ya harness ya wakala: vipengele, faili, matatizo na orodha ya kuanzisha

Imesasishwa: · Skillaria.Top

Harness ya wakala ina vipengele vitano: maelekezo, zana, mazingira, hali na maoni. Seti ndogo ya faili ni AGENTS.md kama rauta fupi, skripti ya ukaguzi (make check, verify.sh), faili la maendeleo, na orodha ya vipengele pamoja na hali zao; hali ya kukamilika inatolewa na skripti, si na wakala.

Vipengele vitano vya harness ya wakala

KipengeleNi niniVifaaDalili ya kuvunjika
MaelekezoWakala anachopaswa kujua kuhusu mradiAGENTS.md / CLAUDE.md, skills, docs/, ADRAnakiuka makubaliano yanayojulikana
ZanaWakala anaweza kufanya ninishell, majaribio, linter, browser, seva za MCP«Anataka lakini hawezi»
MazingiraWakala anafanya kazi wapifaili za lock, Docker/devcontainer, git worktree, sandbox, init.shKikao kinaanza kwa kurekebisha mazingira
HaliKinachodumu baada ya kuanzishwa upyaPROGRESS.md, DECISIONS.md, feature_list.json, commitKikao kipya hakijui kazi ilipoishia
MaoniWakala anajuaje kuhusu makosa yakemake check, E2E, hooks, arch-check, mkaguzi«Imekamilika», lakini haifanyi kazi

Mpangilio wa kujenga kutoka mwanzo: maoni → maelekezo → hali → mazingira → zana.

Faili za harness

FailiKaziKanuni
AGENTS.md / CLAUDE.mdMlango wa kuingilia: mradi ni nini, unauendeshaje, unakaguajeRauta fupi (takriban mistari 80), viungo vya nyaraka vyenye sharti la «lini usome»
docs/*.mdMaelezo ya kina kwa madaHusomwa inapohitajika, si yote
.claude/skills/*/SKILL.mdTaratibu zinazorudiwa (deploy, review)Hupakiwa kazi inapolingana na maelezo yake
PROGRESS.mdHali, yaliyokamilika, vikwazo, hatua zinazofuataHusasishwa mwishoni mwa kila kikao
DECISIONS.mdUamuzi, sababu, chaguzi zilizokataliwaAndika njia, si hitimisho tu
feature_list.jsonVipengele: behavior, verification, stateKipengele kimoja tu active (WIP=1)
scripts/verify.shKukagua kipengele na kukipandisha hadi passingYeye pekee anayeweka passing, pamoja na SHA ya commit
scripts/arch-check.shMipaka ya muundoMsimbo 1 + WHY na FIX kwenye matokeo
scripts/init.shKukagua mazingira kabla ya kaziMazingira, git safi, make check ya kijani, kipengele kinachotumika
sprint contractMkataba wa kila kipengele kabla ya msimboNdani ya wigo / nje ya wigo / maswali wazi
.claude/settings.jsonRuhusa na hooks za Claude CodeUkaguzi kwenye matukio, si kwenye kumbukumbu ya wakala

Muundo wa AGENTS.md

# Mradi: backend ya malipo (FastAPI, PostgreSQL)

## Kuendesha
docker compose up -d && ./scripts/init.sh

## Ukaguzi
make check   # lint, aina, kitengo, arch-check
make e2e     # hali za mwisho-hadi-mwisho

## Definition of Done
- make check na make e2e — msimbo 0
- kipengele kinapandishwa hadi passing na skripti ya scripts/verify.sh
- PROGRESS.md imesasishwa

## MUST
- maswali ya database kupitia repository tu
- siri kutoka kwenye vigezo vya mazingira tu

## Nyaraka
- docs/payments.md — kazi inapogusa malipo na marejesho
- docs/migrations.md — schema ya database inapobadilika

Hali za kipengele

HaliMaanaNani anabadilisha
pendingIko kwenye foleniMpangaji
activeInafanyiwa kazi (moja tu)Wakala, mwanzoni
passingUkaguzi umepitaverify.sh pekee
blockedInahitaji uamuzi wa binadamuWakala, pamoja na sababu

Ngazi za uthibitishaji

NgaziNiniLini
1Lint, ainaKila wakati
2Majaribio ya kitengo na ujumuishajiKila wakati
3E2EMabadiliko yanagusa zaidi ya tabaka moja; kabla ya «imekamilika»
4arch-checkUingizaji mpya unaovuka tabaka

Haki ya kusema «imekamilika» ni baada ya ngazi ya juu kabisa tu. Majaribio ya kitengo ya kijani si utayari.

Kufanya kanuni ziwe za kimashine

NgaziZanaGharama
Guard ya grepSkripti ya kutafuta muundo yenye ujumbe wa WHY/FIXDakika
Kanuni ya linterimport-linter (Python), dependency-cruiser, eslint-plugin-boundaries (JS/TS)Saa moja
Jaribio la muundoJaribio kwenye CI linaloshindwa tabaka zinapokiukwaZaidi, lakini linaonekana kwenye make check
#!/usr/bin/env bash
fail=0
if grep -rn "from app.db" app/services/; then
  echo "WHY: service haziungani moja kwa moja na database"
  echo "FIX: tumia repository kutoka app/repositories/"
  fail=1
fi
exit $fail

Matatizo ya kawaida na suluhisho

TatizoKipengeleSuluhisho
Kanuni ya CLAUDE.md haifuatwiMaelekezoPunguza faili, geuza kanuni kuwa ukaguzi au hook
Wakala hawezi kuendesha majaribioZanaRuhusu amri, sakinisha utegemezi kwenye image
Tabia inatofautiana kati ya mashineMazingiraFaili za lock, Docker/devcontainer, matoleo maalum ya runtime
Usahaulifu kati ya vikaoHaliPROGRESS.md, makabidhiano ya kikao, kusoma mwanzoni
Vipengele vitatu vimeanza, hakuna kilichomalizikaHaliWIP=1 kwenye feature_list.json
«Imekamilika», lakini haifanyi kaziMaoniDoD, E2E, verify.sh, mkaguzi huru
Majaribio ya kijani, kipengele kimevunjikaMaoniE2E yenye database na usanidi halisi
Wakala anaiga mifumo mibayaMaoniarch-check tangu siku ya kwanza
Haieleweki wakala alifanya niniHaliCommit ndogo, ripoti kwenye PROGRESS.md, DECISIONS.md
Wakala ameharibu mazingira usikuMazingiraSandbox, git worktree, vituo vya kuhifadhi, rollback kupitia init.sh
Maoni yale yale ya review mara mbiliHarness kwa ujumlaGeuza kuwa ukaguzi kwenye make check, ondoa maandishi kwenye maelekezo

Majukumu kwa kazi ndefu

JukumuHufanyaHafanyi
MpangajiVipengele vyenye vigezo vya kukubalikaHaandiki msimbo
JeneretaHutekeleza kipengele kimoja, huendesha majaribioHaamui kama kimekamilika
MkaguziHutoa hukumu kwa rubriki, akitaja faili, mstari, kumbukumbuHaoni hoja za jenereta
MergeCommit review == pass inapotokeaNi msimbo, si wakala

Bajeti ya kazi ya kujiendesha

  • Lengo — sentensi moja (kwa mfano kupeleka vipengele vyote hadi passing).
  • WIP=1, kikomo cha muda na majaribio kwa kila kipengele.
  • Kipimo kinapanda kwa mfululizo; regression inamaanisha rollback mara moja.
  • Migration, miundombinu, fedha — upandishaji kwa binadamu.
  • Baada ya review kadhaa kushindwa, kipengele kinaanzishwa upya kwa muktadha safi.

Orodha ya kuanzisha wakala

  1. AGENTS.md ipo: stack, jinsi ya kuendesha, amri ya ukaguzi, DoD.
  2. make check inapita kwenye clone safi.
  3. Mazingira yanaweza kuzalishwa upya: faili za lock, Docker au devcontainer.
  4. Amri zinazohitajika zinapatikana kwa wakala; zile hatari zimezuiwa au ziko kwenye sandbox.
  5. Kuna E2E angalau kwa hali kuu.
  6. Kuna PROGRESS.md na kanuni ya kuisoma mwanzoni mwa kikao.
  7. Vipengele vipo kwenye orodha pamoja na hali zake, kimoja tu kikiwa kinatumika.
  8. Hali ya passing inatolewa na skripti.
  9. Ujumbe wa ukaguzi una WHY na FIX.
  10. Kazi imeandikwa pamoja na vigezo vya kukubalika na mipaka ya wigo.
  11. Imeamuliwa ni nini kinahitaji uamuzi wa binadamu.
  12. Verification gap imepimwa kabla ya mabadiliko, kwa ulinganisho.

Vipimo vya harness

KipimoJinsi ya kukihesabu
Verification gapSehemu ya «imekamilika» bila uthibitisho wa ukaguzi kwenye kazi 10
MTTRMuda kutoka kuvunjika hadi kurejea kwenye hali ya kazi
Cold startKama kikao kipya kinaweza kujibu «tuko wapi, nini kinafuata» bila kukisia
AblationKushuka wakati kipengele kimoja kinazimwa kwenye seti ya kazi iliyo thabiti

Kwa ufupi

Harness ni mzunguko, si faili moja: maelekezo, zana, mazingira, hali na maoni. Anza na ukaguzi, weka AGENTS.md fupi, mpe skripti jukumu la hali ya kukamilika, na pitia harness mara kwa mara. Yote haya yanakusanywa kuwa kitu kimoja katika mradi wa kozi ya harness engineering.

Maswali ya mara kwa mara

AGENTS.md inatofautianaje na CLAUDE.md?

Kwa kusudi ni kitu kimoja: faili la maelekezo kwa wakala. CLAUDE.md inasomwa na Claude Code, AGENTS.md ni muundo wa pamoja kwa mawakala mbalimbali; katika CLAUDE.md unaweza tu kutaja AGENTS.md.

AGENTS.md inapaswa kuwa na mistari mingapi?

Hakuna kikomo kigumu, lakini faili la kuingilia ni bora liwe fupi — kama mistari mia hivi, kama faharasa. Maelezo yanahamia kwenye nyaraka tofauti.

Je, feature_list.json inahitajika kwa mradi mdogo?

Kwa mabadiliko ya mara moja hapana. Inalipa wakala anapofanya kazi kwenye vipengele kadhaa mfululizo au katika vikao kadhaa.

Siri ambazo wakala anahitaji ziwekwe wapi?

Kwenye vigezo vya mazingira au kwenye meneja wa siri, si kwenye faili la maelekezo wala kwenye msimbo. Mpe wakala ufikiaji wa mazingira, si thamani za siri zilizoandikwa kwenye maandishi.