انتقل إلى المحتوى
أمين أبوزيد
درس مخطط لهMID-063-L01

توثيق يُقرأ فعلًا

  • الدرس 1 من 7
  • Mid-level
في هذا الدرس 4 موضوعات

هذا الدرس مخطط له. يعرض المخطط أدناه الموضوعات التي سيغطيها، ولم يُنشر الدرس الكامل بعد.

نص الدروس والتمارين باللغة الإنجليزية، بينما تبقى واجهة الموقع وعناوين الدروس بالعربية.

في هذا الدرس

write docs people actually use.

الموضوعات المخطط لها

  • Write for a named reader with a named question: new joiner, on-call engineer, reviewer.
  • Keep docs next to the code (docs as code): reviewed in pull requests, versioned in git.
  • Prefer a few short, current documents over many stale ones; give each an owner and a date.
  • Document why, not what; the code already says what.
  • Every diagram needs a title and a legend.
تفاصيل المخطط المبدئي

عرض عملي

a docs folder layout: docs/adr/, docs/rfc/, docs/architecture/, docs/runbooks/.

اختبر فهمك

What goes wrong with a diagram that has no legend?

أظهر الإجابة

Readers guess what boxes and arrows mean.

التطبيق

طبّق هذا الدرس بمختبر الوحدة وتمارينها واختبارها.

المختبر والتمارين الاختبار

تعليم الدرس كمكتمل اختياري ويمكنك التراجع عنه في أي وقت. يبقى تقدمك محفوظًا في هذا المتصفح.

اكتب للبحث في المستويات والمراحل والوحدات والدروس.