استاندارد نوشتن و نگهداری مستندات
ساختار مقاله، تصویر، نسخه و جلوگیری از اطلاعات قدیمی.
ساختار پیشنهادی
هر مقاله یک هدف مشخص، پیش‌نیاز، مراحل شماره‌دار، نتیجه مورد انتظار و بخش عیب‌یابی کوتاه داشته باشد.
عنوان و جستجو
از واژه‌ای استفاده کنید که کاربر در پیشخوان می‌بیند. عنوان‌های مبهم یا ترجمه تحت‌اللفظی ننویسید.
تصویر
تصویر فقط برای مرحله‌ای قرار گیرد که بدون آن ممکن است اشتباه شود. اطلاعات ورود و داده شخصی را محو کنید.
به‌روزرسانی
پس از هر انتشار محصول، فهرست گزینه‌ها و المان‌ها را با نسخه واقعی مقایسه کنید. مقاله‌های ساخته‌شده توسط بسته اولیه فقط زمانی خودکار به‌روز می‌شوند که مدیر محتوای آن‌ها را دستی تغییر نداده باشد.
الگوی پیشنهادی هر راهنما
- یک جمله که نتیجه نهایی را روشن کند.
- مسیر دقیق ورود در پیشخوان.
- پیش‌نیازها و اطلاعاتی که باید آماده باشند.
- مراحل شماره‌دار، هر مرحله با یک اقدام مشخص.
- توضیح گزینه‌ها و زمان استفاده از آن‌ها.
- یک مثال واقعی.
- روش بررسی نتیجه در موبایل و دسکتاپ.
- خطاهای رایج و راه حل کوتاه.
لحن نوشتن
با کاربر مستقیم و محترمانه صحبت کنید. جمله کوتاه و فعل روشن بنویسید. نامی را استفاده کنید که در رابط دیده می‌شود و اصطلاح انگلیسی را فقط وقتی لازم است داخل پرانتز بیاورید. از عبارت‌های ترجمه‌وار، تعریف تبلیغاتی و وعده مبهم دوری کنید.
تصویر و اطلاعات حساس
تصویر باید یک مرحله دشوار را روشن کند، نه اینکه متن را تکرار کند. نشانی ایمیل، کلید API، رمز، شماره سفارش و اطلاعات مشتری را پیش از انتشار محو کنید.
بازبینی انتشار
مراحل را با یک حساب تازه انجام دهید، همه لینک‌ها را باز کنید، عنوان‌ها را از نظر فهرست صفحه بررسی و تاریخ و نسخه را به‌روز کنید.