documentation:start
فهرست مندرجات
مستندات فنی
این بخش برای گردآوری و نگارش مستندات دقیق دربارهٔ نرمافزارها، پروتکلها، استانداردها، معماری سیستمها و فناوریهای زیرساختی ایجاد شده است.
برخلاف راهنماهای مقدماتی که بر انجام یک کار مشخص تمرکز دارند، مستندات فنی باید به درک ساختار، سازوکار، رفتار و محدودیتهای یک فناوری کمک کنند.
انواع مستندات
- مستندات معماری: اجزا، ارتباطات و تصمیمهای طراحی یک سیستم
- مستندات پروتکل: قالب پیامها، فرایند ارتباط و رفتار مورد انتظار
- مستندات رابط برنامهنویسی: توابع، ورودیها، خروجیها و خطاها
- مستندات پیکربندی: گزینهها، مقادیر پیشفرض و اثر هر تنظیم
- مستندات عملیاتی: پایش، نگهداری، بازیابی و مدیریت سرویس
- مستندات امنیتی: مدل تهدید، مرزهای اعتماد و کنترلهای امنیتی
اصول نگارش
- اصطلاحات را دقیق و یکدست به کار ببرید.
- رفتار واقعی سیستم را از فرضها و تفسیرهای شخصی جدا کنید.
- نسخه، تاریخ و دامنهٔ اعتبار مستندات را مشخص کنید.
- در صورت امکان، مثال، نمودار و نمونهٔ ورودی و خروجی ارائه کنید.
- به استاندارد یا مستندات اصلی ارجاع دهید.
- موارد نامشخص یا وابسته به نسخه را صریحاً مشخص کنید.
قالب پیشنهادی
هر سند بهتر است شامل عنوان، خلاصه، دامنه، پیشنیازها، شرح فنی، مثالها، محدودیتها، منابع و تاریخ آخرین بازبینی باشد.
مشارکت
مستندات را با ارجاع به منابع اولیه، بررسی رفتار نرمافزار و ثبت اصلاحات بهبود دهید. در صورت تغییر نسخه یا استاندارد، بخشهای متأثر را بازبینی کنید.
documentation/start.txt · آخرین ویرایش: توسط delta
