قوالب صفحات التوثيق
هذا المرجع يحدد شكل الصفحات الاحترافية التي نريدها في apps/docs.
Frontmatter القياسي للصفحات المهمة
last_verified: 2026-04-11
status: current
source_of_truth: apps/... أو infrastructure/...
audience: public | operator | internal
owner: team-or-domain-owner
surfaces:
- customer-web
- dashboard
قالب صفحة مرجع ميزة عامة أو تشغيلية
- الغرض
- أين تظهر
- الإجراءات الأساسية
- حالات الواجهة أو الحالة التشغيلية
- الأهلية/الصلاحيات/التوفر
- حالات الفشل والبدائل
- APIs أو الصفحات المرتبطة
- source of truth
قالب صفحة API عالية الخطورة
- Base URL أو surface context
- auth model
- request shape
- response shape
- failure responses
- rate limiting / session notes
- routes المالكة في الكود
قالب runbook
- متى يستخدم
- الشروط المسبقة
- خطوات التنفيذ
- التحقق بعد التنفيذ
- التصعيد
- rollback أو الاستعادة
قاعدة مهمة
الهدف ليس توحيد الأسلوب شكلياً فقط، بل توحيد قابلية الوثوق: أي قارئ يعرف أين يجد الأهلية والحالات والفشل والمرجع البرمجي.