راهنمای کاربری
هدف: کمک به انجام کار مشخص؛ دارای مراحل عملی، پیش‌نیاز و راه رفع خطا.
استاندارد نگهداری و بازبینی مستندات رونما
RUNAMA / KNOWLEDGE
قواعد اجرایی پیشنهادی برای مدیریت هزاران راهنما، سند رسمی، مدخل دانشنامه و یادداشت انتشار. این سند استاندارد آینده است و اجرای خودکار همه قواعد را ادعا نمی‌کند.
انواع اسناد و مسئولیت‌ها
سند حقوقی و سیاست
هدف: تعریف حقوق، تعهدات و فرآیند رسمی؛ تغییر آن نیازمند بررسی مسئول محتوایی/حقوقی است.
سند فنی
هدف: پارامتر، رفتار، خطا، نسخه و محدودیت اتصال؛ باید با سرویس واقعی هم‌خوان باشد.
مدخل دانشنامه
هدف: توضیح مفهوم با منابع، تاریخ و مرز قطعیت؛ متفاوت از دستورالعمل محصول.
یادداشت انتشار
هدف: ثبت تغییرات واقعی هر نسخه و وضعیت آزمون آن.
چرخه بازبینی
مالک سند
برای هر سند باید مسئول بازبینی تعیین شود؛ در صورت نامشخص‌بودن، وضعیت «مالک نامشخص» ثبت شود.
وضعیت بازبینی
مقادیر پیشنهادی: تأییدشده، نیازمند بازبینی، منسوخ، پیش‌نویس؛ این‌ها باید بر مبنای شواهد ثبت شوند.
تاریخ آخرین بازبینی
تنها زمانی ثبت شود که بررسی محتوا عملاً انجام شده باشد؛ تاریخ ویرایش وردپرس جایگزین آن نیست.
تناوب بازبینی
راهنماهای متکی به رابط متغیر زودتر از توضیح‌های ثابت بررسی شوند؛ اسناد حقوقی پس از تغییر قانون/سیاست نیز بازبینی شوند.
حفظ نشانی و ارجاع
URL صفحه موجود تغییر نکند مگر با نقشه انتقال، ریدایرکت ۳۰۱ و کنترل لینک‌های داخلی.
کیفیت انتشار
کنترل منبع
در مطالب مستند، منابع اصلی و شواهد قابل‌بررسی مشخص باشند.
سنجش لینک و تاریخ
قبل از انتشار و بازبینی، لینک‌ها، تاریخ رخداد و تاریخ به‌روزرسانی کنترل شوند.
مسیر گزارش خطا
گزارش کاربر باید به سند، خطا و مسئول بازبینی مربوط شود.
امنیت و حریم خصوصی
گزارش‌های فنی نباید شامل رمزها، توکن‌ها یا اطلاعات خصوصی کاربران باشند.
زمان تقریبی مطالعه: ۱ دقیقه