Document

Mikor használd

Futtasd a /impeccable document parancsot, ha már van annyi vizuális rendszered, hogy dokumentálni érdemes: színek, tipográfia, legalább egy gomb és egy kártya. A parancs átvizsgálja a kódbázist, kinyeri a talált tokeneket és komponensmintákat, és egy DESIGN.md fájlt ír a projekt gyökerébe, amely követi a Google Stitch DESIGN.md formátumot, hat szakasz rögzített sorrendben, kompatibilis minden más DESIGN.md-tudó eszközzel.

Nyúlj hozzá, amikor:

• Éppen futtattad a /impeccable teach parancsot és a PRODUCT.md már létezik. A document az ehhez tartozó vizuális oldal fájl.
• Egy parancs felhívta a figyelmedet. A Live, craft és polish parancsok mind olvassák a DESIGN.md-t. Ha hiányzik, a szakértelem javasolja, hogy előbb futtasd a document parancsot.
• A dizájn elcsúszott egy régebbi DESIGN.md-hez képest, és a fájl már nem írja le az élő rendszert.
• Egy nagy átdizájn előtt, hogy az aktuális állapot referenciaként rögzüljön a következő irányhoz.

Olyan projekteknél, ahol még nincs kód (friss teach futtatás, semmi sincs felépítve), van egy vetési mód: az /impeccable document --seed öt gyors stratégiai kérdést tesz fel (színstratégia, tipográfiai irány, mozgásenergia, referenciák, anti-referenciák), és egy állványzatot ír. Futtasd újra vizsgálati módban, ha már van kód.

Hogyan működik

A vizsgálati futás prioritási sorrendben keresi a dizájneszközöket: CSS egyéni tulajdonságok, Tailwind konfig, CSS-in-JS témák, dizájntoken fájlok, komponensforrás, a globális stíluslap, és végül a kiszámított stílusok az élő renderelt kimenetből, ha elérhető böngésző. Mindent automatikusan kinyer, amit tud, majd egyetlen csoportosított kérdést tesz fel azokról a részekről, amelyek kreatív bevitelt igényelnek: a Kreatív Északi Csillag (egyetlen elnevezett metafora az egész rendszerre, mint „A Szerkesztőségi Szentély”), leíró színnevek, a kiemelésfilozófia és a komponensjellemző.

A kimenet egy DESIGN.md pontosan hat szakasszal: Áttekintés, Színek, Tipográfia, Kiemelés, Komponensek, Tennivalók és Tilalmak. A fejlécek karakterpontra rögzítettek, hogy a fájl más eszközök által elemezhető legyen. Mellette a DESIGN.json gépileg olvasható mellékként íródik. Ez a mellék az, amit a live-mode dizájn panel használ arra, hogy ezen projekt tényleges gomb-, bemenet-, navigációs és kártyacsempéit renderelje generikus közelítés helyett.

Minden más parancs a meghíváskor beolvassa a DESIGN.md-t. A variánsok, polírozások, auditok és új funkciók a vizuális rendszert kapásból öröklik, anélkül, hogy meg kellene mondani.

Próbáld ki

/impeccable document

Egy olyan projektnél, ahol már definiáltak a tokenek, ez körülbelül két percet vesz igénybe: a vizsgálat megtalálja a palettát és a tipográfiai vermet, választasz egy Északi Csillagot 2 vagy 3 lehetőség közül, megerősíted a leíró színneveket („Mély tompa ciánkék”, nem „blue-800”), és a fájl a projekt gyökerébe kerül.

Egy friss projektnél:

/impeccable document --seed

Öt kérdés, körülbelül öt perc. A fájl egy állványzat, egy <!-- SEED --> kommenttel megjelölve, őszintén jelzi, mi is valójában. Futtasd újra a flag nélkül, miután implementáltad a tokeneket.

Gyakori buktatók

• Túl korai futtatás. Olyan projektnél, ahol nincsenek implementált tokenek, a vetési mód a helyes választás. Ne gyárts teljes specifikációt, amit a kód nem tud alátámasztani. Egy hamis DESIGN.md rosszabb, mint egyáltalán nincs DESIGN.md.
• A DESIGN.md kezelése kizárólag emberi dokumentációként. Elsősorban az AI-nak szól. Minden más parancs beolvassa. A formátum határozottsága („soha”, „mindig”, Elnevezett Szabályok) szándékos.
• Elrendezés / Mozgás / Reszponzív legfelső szintű szakasz hozzáadása. A spec hat szakaszból áll, rögzített sorrendben, rögzített nevekkel. Az elrendezés vagy mozgás tartalmát csomagold az Áttekintésbe (filozófiai szintű szabályok) vagy a Komponensekbe (komponensenkénti viselkedés).
• Meglévő DESIGN.md csendes felülírása. A document mindig megerősítést kér. Ha tiszta lappal akarsz indulni, nevezd át a meglévő fájlt, vagy mondd meg kifejezetten a szakértelemnek, hogy írja felül.