ایمورتالویژن
English
بلاگ →

مستنداتی که از خود محصول ماندگارترند

چطور مستندات محصول را می‌نویسیم و به‌روز نگه می‌داریم تا با آمدن و رفتن آدم‌ها گم نشود.

#docs#architectureنسخه انگلیسی ↗

مستندات جزئی از سیستم است

اگر معماری فقط در ذهن یک نفر باشد، با رفتن او از دست می‌رود. هر سیستمی که تحویل می‌دهیم مستندات محصول دارد که کنار کد و در همان مخزن نگه‌داری می‌شود.

  • تصمیم‌ها را می‌نویسیم، نه این‌که به حافظه بسپاریم.
  • هر سرویس توضیح می‌دهد چطور با یک دستور روی سیستم خودتان اجرا شود.
  • مستندات در همان pull request کدی که توضیحش می‌دهند بازبینی می‌شوند.