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

مستنداتی که از خود محصول بیشتر عمر می‌کنند

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

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

مستندات بخشی از سیستم است

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

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