تخطَّ إلى المحتوى

التوثيق الداخلي

الدرس 16 من 20

الهدف

بعد هالدرس عندك RUNBOOK.md يغطي أهم 5 عمليات في منتجك، 3 admin scripts تشغّلها فعلا (مو تكتبها وتنساها)، و**docs/decisions/** فيه سبب كل قرار رئيسي اتخذته — هذا كل التوثيق اللي تحتاجه كـ solo founder.

ليش هذا الحين؟

كل solo founder يصير له نفس الشي: ينسى كيف يسوي DB migration في production بعد شهرين. أو يقعد ساعتين يحاول يتذكر ليش اختار Neon بدل Supabase.

بس ترى التوثيق مو للـ team — هو لنفسك في المستقبل. أو لأي freelancer تجيبه يساعدك. أو للـ investor اللي يبي يفهم البنية.

الـ Notion wikis والـ Confluence والـ Confluence-alternatives = enterprise. Solo founder يحتاج: Markdown files في الـ repo + اتساق.

الفكرة

أداتنا: Markdown في الـ repo نفسهdocs/ folder مع ملفات بسيطة. لا Notion، لا Confluence، لا Coda. الملفات في الـ repo = يـ version-controlled، يفتح في أي editor، ما تدفع subscription.

ثلاثة ملفات أساسية:

  1. RUNBOOK.md — إجراءات تشغيلية (كيف تسوي X)
  2. docs/decisions/ — ليش اخترنا X بدل Y
  3. scripts/ — admin scripts موثّقة

محتاج مساعدة؟ راسلنا على mj@shakesbeard.net