SOP: رمزگذاری دانش نادیدنی در مخزن | مهندسی هارنس

وقتی بخش مهمی از زمینه هنوز در Google Docs، گفتگوها، تیکت‌ها یا ذهن آدم‌هاست، از این رویه استفاده کنید.

هدف#

دانشی را که برای ایجنت نادیدنی است در کدبیس قابل کشف کنید، تا یک نشست تازه بدون تکیه بر گفتگوهای قبلی بتواند از آن استفاده کند.

ایجنت مدام می‌پرسد سیستم چطور کار می‌کند.
آدم‌ها می‌گویند «این را در Slack تصمیم گرفتیم» یا «همان را که فلانی هفته‌ی پیش گفت دنبال کن».
بازبینی‌ها به قواعد محصول یا امنیتی اشاره می‌کنند که در مخزن نوشته نشده‌اند.
نشست‌های تازه کار کشفی را تکرار می‌کنند که باید تا حالا حل‌شده باشد.

منابع دانش نادیدنی را فهرست کنید: سندها، گفتگوها، قواعد ضمنی تیم، تصمیم‌های شفاهی.
برای هر منبع بپرسید: این معماری است، رفتار محصول، سیاست امنیتی، انتظار قابلیت اطمینان، زمینه‌ی برنامه یا مطلب مرجع؟
آن را در مصنوع متناسب مخزن بنویسید: - معماری ← ARCHITECTURE.md - رفتار محصول ← docs/product-specs/ - دلیل طراحی ← docs/design-docs/ - وضعیت اجرا ← docs/exec-plans/ - مراجع بیرونی تکراری ← docs/references/ - انتظارات کیفیت یا قابلیت اطمینان ← docs/QUALITY_SCORE.md یا docs/RELIABILITY.md
جمله‌های مبهم را با عبارت‌های عملیاتی و قابل استفاده جایگزین کنید.
نسخه‌های کهنه را حذف یا منسوخ کنید تا مخزن فقط یک حقیقتِ قابل کشف داشته باشد.