Skip to main content

حکمرانی مستندات

اصل کلی: یک موضوع، یک مرجع. صفحهٔ مرجع هر موضوع را کامل توضیح می‌دهد و بقیهٔ صفحات فقط لینک می‌دهند. سه وضعیت «کد فعلی»، «هدف» و «پیشنهاد» باید از هم جدا بمانند.

موضوعمنبع مرجع
قرارداد wirepackages/contracts؛ OpenAPI خروجی آن
رفتار اجراشدهroute/service/client و تست‌های مرتبط؛ خلاصهٔ انسانی در sync
قید ذخیرهPrisma schema و migrations (با هم)
هدف/پذیرش طراحیطراحی و وضعیت پذیرش با شاهد کد
توکن طراحیpackages/design-tokens/tokens.json، نه خروجی‌های تولیدشده
تاریخچهGit و ui-design/history — نه مرجع رفتار فعلی

چرخهٔ عمر​

صفحات design/ui و هر صفحه‌ای که doc_type دارد، این فیلدهای frontmatter را لازم دارند:

فیلدمقدارهای مجاز
doc_typereference / guide / proposal / archive
statusnormative / experimental / deprecated
implementationcomplete / partial / not-started / not-applicable
platformsweb / android / docs / api
ownerdesign-system / api / web / mobile / docs
last_reviewedتاریخ ISO

تفسیر فیلدها: normative می‌تواند هدف باشد و implementation می‌گوید چقدر از آن واقعاً اجرا شده — این دو را با هم یکی نگیرید. proposal رفتار فعلی نیست و archive از ناوبری جاری کنار می‌رود. تاریخ last_reviewed فقط بعد از مرور واقعی تغییر کند؛ دیدن DTO/تصویر/تست محدود، تضمین قابلیت یا بی‌اتلاف‌بودن نیست.

کنترل​

از ریشه:

npm run check:governance --prefix docs

این بررسی metadata را کامل می‌سنجد، لینک مرجع به specهای تاریخ‌دار را رد می‌کند، فایل‌های UI در sidebar را می‌پذیرد/رد می‌کند، وجود تصاویر catalog را چک می‌کند و منبع prototype/catalog را کنترل می‌کند. تعداد و عنوان بخش‌های اجباری نیست. توجه: build لینک شکسته را می‌گیرد اما صحت نثر را نه — تست‌ها.