agentleFS
Sign inStart free
vSkyfallvSkyfall/sky/skills/sky-architecture-docs/SKILL.md

sky-architecture-docs

Skill8 starsChanged 6 days agoMITView on GitHub

Mimari dokümantasyon: README yapısı, ADR (mimari karar kaydı) şablonu ve ne zaman yazılır, C4 modeli ile Mermaid diyagramları (bağlam, konteyner, bileşen), veri akışı ve sıra diyagramları, CODEMAP (klasör haritası), çalışma kitapları (runbook) ve dokümanı kodla güncel tutma. "Mimariyi dokümante et", "ADR yaz", "diyagram çiz", "README düzenle" dendiğinde kullan.

The file

Create a free account to mount
Files
SKILL.md

Sky · Mimari Dokümanlar

README (her repo)

# Proje — tek cümle
Ekran görüntüsü / demo bağlantısı
## Hızlı başlangıç (≤ 5 komut)
## Mimari (1 diyagram + 5 madde)
## Komutlar
## Ortam değişkenleri (→ docs/ENV.md)
## Dağıtım
## Katkı / kurallar (→ CLAUDE.md)

ADR — Mimari Karar Kaydı

Ne zaman: geri dönmesi pahalı kararlar (DB, auth sağlayıcı, monorepo, ödeme sağlayıcı, multi-tenancy modeli), "neden böyle?" sorusunun tekrar soracağı kararlar.

# ADR-007: Randevu saatlerini işletme saat diliminde saklıyoruz
Tarih: 2026-11-04 · Durum: Kabul edildi
## Bağlam
İşletmeler farklı şehirlerde; çalışma saatleri yerel duvar saati…
## Karar
`working_hours` yerel saat + `timezone`; `bookings` timestamptz (UTC).
## Değerlendirilen alternatifler
1. Her şey UTC — yaz saati olan bölgelerde çalışma saatleri kayar. 2. …
## Sonuçlar
+ … − slot hesaplamasında dilim dönüşümü gerekir (lib/slots.ts).

docs/adr/NNN-kebab-baslik.md, numaralı, değiştirilmez (yeni karar eskisini "Yerini aldı: ADR-012" ile işaretler).

C4 + Mermaid

flowchart LR
  user([Müşteri]) -->|rezervasyon| web[Next.js uygulaması]
  staff([Personel]) --> web
  web --> db[(Postgres / Supabase)]
  web --> queue[[Inngest işleri]]
  queue --> sms[Netgsm SMS]
  queue --> mail[Resend e-posta]
  web --> pay[iyzico]
  • Seviye 1 bağlam (sistem + kullanıcılar + dış sistemler), seviye 2 konteynerler (uygulama, DB, kuyruk, CDN). Çoğu projede ikisi yeter.
  • Akışlar için sıra diyagramı (sequenceDiagram): ödeme, webhook, randevu oluşturma.
  • Mermaid GitHub ve çoğu doküman aracında render olur; diyagram kodla birlikte sürümlenir.

CODEMAP

docs/CODEMAP.md: klasör → sorumluluk → giriş noktaları → "şunu değiştirmek istersen buraya bak". 1 ekran. Yeni geliştirici ve AI için en hızlı yönlendirme (sky-codebase-mapper yöntemi üretebilir).

Güncel tutma

  • Doküman kodun yanında (repo içinde), PR kontrol listesinde "doküman güncellendi mi?".
  • Diyagramları koddan türet (mümkünse): şemadan ERD (drizzle-kit/prisma-erd-generator), OpenAPI'den API dokümanı.
  • Eskimiş doküman "⚠️ güncel değil" işaretlenir veya silinir.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free