Document

Ne zaman kullanılır

Görsel sisteminizi belgeleyecek kadar materyale sahip olduğunuzda /impeccable document komutunu çalıştırın: renkler, tipografi, en azından bir düğme ve bir kart. Komut, kod tabanınızı tarar, bulduğu token’ları ve bileşen kalıplarını çıkarır ve proje köküne Google Stitch DESIGN.md formatıyla uyumlu, sabit sıralı altı bölümden oluşan, diğer DESIGN.md uyumlu araçlarla birlikte çalışabilen bir DESIGN.md yazar.

Şu durumlarda kullanın:

• Az önce /impeccable teach komutunu çalıştırdınız ve PRODUCT.md artık mevcut. Document, buna karşılık gelen görsel taraf dosyasıdır.
• Bir komut sizi bu dosyaya yönlendirdi. Live, craft ve polish komutlarının tümü DESIGN.md dosyasını okur. Eğer dosya eksikse, beceri önce document komutunu çalıştırmanızı önerir.
• Tasarım eski bir DESIGN.md dosyasından sapma gösterdi ve dosya artık canlı sistemi tanımlamıyor.
• Büyük bir yeniden tasarım öncesinde, bir sonraki yön için referans olarak mevcut durumu yakalamak için.

Henüz kodu olmayan projeler için (yeni bir teach çalıştırması, henüz oluşturulmamış), bir tohum modu vardır: /impeccable document --seed beş kısa stratejik soru sorar (renk stratejisi, tipografi yönü, hareket enerjisi, referanslar, anti-referanslar) ve bir iskelet yazar. Kod oluştuktan sonra tarama modunda yeniden çalıştırın.

Nasıl çalışır

Tarama geçişi, tasarım varlıklarını öncelik sırasına göre bulur: CSS özel özellikleri, Tailwind yapılandırması, CSS-in-JS temaları, tasarım token dosyaları, bileşen kaynak kodu, genel stil sayfası ve son olarak bir tarayıcı mevcutsa canlı oluşturulan çıktıdan hesaplanan stiller. Otomatik olarak bulabildiği her şeyi çıkarır, ardından yaratıcı giriş gerektiren parçalar için bir gruplandırılmış soru sorar: Creative North Star (tüm sistem için tek bir adlandırılmış metafor, örneğin “The Editorial Sanctuary”), açıklayıcı renk adları, yükseltme felsefesi ve bileşen karakteri.

Çıktı, tam olarak altı bölümden oluşan bir DESIGN.md dosyasıdır: Overview, Colors, Typography, Elevation, Components, Do’s and Don’ts. Başlıklar, dosyanın diğer araçlar tarafından ayrıştırılabilmesi için karakter karakter sabittir. Yanında, DESIGN.json makine tarafından okunabilir bir yardımcı dosya olarak yazılır. Bu yardımcı dosya, canlı mod tasarım panelinin genel bir yaklaşık gösterim yerine bu projenin gerçek düğme, giriş, gezinti ve kart döşemelerini oluşturmak için kullandığı şeydir.

Diğer tüm komutlar çağrıldığında DESIGN.md dosyasını okur. Varyantlar, cilalar, denetimler ve yeni özellikler, görsel sistemi söylenmeden devralır.

Deneyin

/impeccable document

Önceden tanımlanmış token’ları olan bir projede, bu yaklaşık iki dakika sürer: tarama paletinizi ve tipografi yığınızı bulur, 2 veya 3 seçenekten bir Kuzey Yıldızı seçersiniz, açıklayıcı renk adlarını onaylarsınız (“blue-800” değil, “Deep Muted Teal-Navy”) ve dosya proje köküne yerleşir.

Yeni bir projede:

/impeccable document --seed

Beş soru, yaklaşık beş dakika. Dosya bir iskelet olup, ne olduğu konusunda dürüst olmak üzere bir <!-- SEED --> yorumuyla işaretlenmiştir. Token’ları uyguladıktan sonra bayrak olmadan yeniden çalıştırın.

Tuzaklar

• Çok erken çalıştırmak. Uygulanmış token’ları olmayan bir projede, tohum modu doğrudur. Kodun destekleyemeyeceği tam bir spesifikasyon üretmeyin. Sahte bir DESIGN.md, DESIGN.md olmamasından daha kötüdür.
• DESIGN.md’yi sadece insanlar için belge olarak düşünmek. Bu öncelikle AI içindir. Diğer tüm komutlar bunu okur. Formatın kararlılığı (“asla”, “her zaman”, Adlandırılmış Kurallar) kasıtlıdır.
• Layout / Motion / Responsive üst düzey bölümü eklemek. Spesifikasyonun altı bölümü vardır, sabit bir sıradadır ve sabit isimlere sahiptir. Düzen veya hareket içeriğini Overview bölümüne (felsefe düzeyindeki kurallar) veya Components bölümüne (bileşen başına davranış) katın.
• Mevcut bir DESIGN.md dosyasının sessizce üzerine yazmak. Document her zaman önce onay ister. Yeniden başlamak istiyorsanız, mevcut dosyayı yeniden adlandırın veya beceriye açıkça üzerine yazmasını söyleyin.