Document

Milloin käyttää

Suorita /impeccable document kun sinulla on tarpeeksi visuaalista järjestelmää dokumentoitavaksi: värejä, typografiaa, vähintään painike ja kortti. Komento skannaa koodipohjasi, purkaa tokenit ja komponenttimallit joita se löytää, ja kirjoittaa DESIGN.md:n projektin juureen joka seuraa Google Stitch DESIGN.md -formaattia, kuusi osiota kiinteässä järjestyksessä, yhteensopiva jokaisen muun DESIGN.md-tietoisen työkalun kanssa.

Turvaudu siihen kun:

• Suoritit juuri /impeccable teach-komennon ja PRODUCT.md on nyt olemassa. Document on vastaava visuaalisen puolen tiedosto.
• Komento ohjasi sinua siihen. Live, craft ja polish kaikki lukevat DESIGN.md:tä. Jos se puuttuu, taito ehdottaa documentin suorittamista ensin.
• Suunnittelu on ajautunut vanhemmasta DESIGN.md:stä ja tiedosto ei enää kuvaa live-järjestelmää.
• Ennen suurta uudelleensuunnittelua, nykyisen tilan tallentamiseksi viitteeksi seuraavalle suunnalle.

Projekteille joissa ei ole koodia vielä (tuore teach-ajo, mitään ei rakennettu), on siementila: /impeccable document --seed kysyy viisi nopeaa strategista kysymystä (väristrategia, tyyppisuunta, liike-energia, viitteet, anti-viitteet) ja kirjoittaa rungon. Suorita uudelleen skannaus-tilassa kun koodia on.

Miten se toimii

Skannausläpikäynti löytää suunnitteluresursseja prioriteettijärjestyksessä: CSS-mukautetut ominaisuudet, Tailwind-konfiguraatio, CSS-in-JS-teemat, suunnittelutoken-tiedostot, komponenttilähde, globaali tyylitiedosto ja lopuksi lasketut tyylit live-renderöidystä tulosteesta jos selain on saatavilla. Se autopurkaa kaiken mitä voi, sitten kysyy yhden ryhmitellyn kysymyksen osille jotka tarvitsevat luovaa syötettä: Luova Pohjotähti (yksi nimetty metafora koko järjestelmälle, kuten “Toimituksellinen pyhäkkö”), kuvaavat värien nimet, korkeusfilosofia ja komponenttiluonne.

Tuloste on DESIGN.md tasan kuudella osiolla: Yleiskatsaus, Värit, Typografia, Korkeus, Komponentit, Tehdään ja ei-tehdä. Otsikot ovat kiinteitä merkki merkiltä niin että tiedosto on jäsennettävissä muilla työkaluilla. Sen rinnalla DESIGN.json kirjoitetaan koneluettavana sidecar-tiedostona. Se sidecar on mitä live-tilan suunnittelupaneeli käyttää renderöidäkseen tämän projektin todelliset painike-, syöte-, nav- ja korttilaattojen sijaan yleistä likiarvoa.

Jokainen muu komento lukee DESIGN.md:n kutsuttaessa. Muunnelmat, viimeistelyt, arvioinnit ja uudet ominaisuudet perivät visuaalisen järjestelmän ilman että niille tarvitsee kertoa.

Kokeile

/impeccable document

Projektissa jossa tokenit on jo määritelty, tämä kestää noin kaksi minuuttia: skannaus löytää palettisi ja tyyppipinosi, valitset Pohjotähden 2 tai 3 vaihtoehdosta, vahvistat kuvaavat värien nimet (“Syvä pehmeä sinivihreä”, ei “blue-800”), ja tiedosto laskeutuu projektin juureen.

Tuoreessa projektissa:

/impeccable document --seed

Viisi kysymystä, noin viisi minuuttia. Tiedosto on runko, merkitty <!-- SEED -->-kommentilla joten se on rehellinen siitä mitä se on. Suorita uudelleen ilman lippua kun olet toteuttanut tokenit.

Sudenkuopat

• Ajaminen liian aikaisin. Projektissa jossa ei ole toteutettuja tokeneita, siementila on oikea. Älä fabrikoi täyttä määrittelyä jota koodi ei voi taustaa. Väärä DESIGN.md on huonompi kuin ei DESIGN.md:tä.
• DESIGN.md:n kohteleminen dokumentaationa vain ihmisille. Se on ensisijaisesti tekoälylle. Jokainen muu komento lukee sen. Formaan jämäkkyys (“ei koskaan”, “aina”, Nimetyt Säännöt) on tarkoituksellista.
• Asettelu / Liike / Responsiivinen -tason osion lisääminen. Määrittelyssä on kuusi osiota, kiinteässä järjestyksessä, kiinteillä nimillä. Taita asettelu- tai liikesisältö Yleiskatsaukseen (filosofiatason säännöt) tai Komponentteihin (per komponentti -käyttäytyminen).
• Olemassa olevan DESIGN.md:n ylikirjoittaminen hiljaisesti. Document vahvistaa aina ensin. Jos haluat aloittaa puhtaalta pöydältä, nimeä olemassa oleva tiedosto pois tai kerro taidolle eksplisiittisesti ylikirjoittaa.