چگونه یادداشت‌های انتشار و لاگ تغییرات محصول را منتشر کنم؟

پیش‌نیازها

• این قابلیت برای سایت‌های Help Center و Product Docs طراحی شده است. به‌صورت پیش‌فرض برای نقطه شروع Software یا SaaS فعال است. سایت‌هایی از نوع دیگر نمی‌توانند آن را اضافه کنند.
• برای مدیریت مرکز راهنما به دسترسی لازم نیاز دارید.

مراحل انجام کار

1. بخش خبرها را باز کرده و یادداشت‌های انتشار را انتخاب کنید. با این کار فهرست یادداشت‌های انتشار باز می‌شود.
2. گزینه جدید را انتخاب کنید.
3. موارد عنوان، version و releasedOn یعنی تاریخی که نسخه عرضه شده را وارد کنید. پر کردن این سه مورد الزامی است.
4. اختیاری: خلاصه تا سقف ۱۰۰۰ نویسه، و پیوند به صفحه‌ای طولانی‌تر.
5. برای هر تغییر یک خط در کادر فهرست اضافه کنید. در این فرم، این فهرست با عنوان لحظه‌ها نمایش داده می‌شود. وضعیت نوع آن را تعیین کنید: جدید، بهبودیافته یا رفع‌شده. متن را تا حداکثر ۳۰۰ نویسه بنویسید. می‌توانید تا ۱۰۰ خط اضافه کنید.
6. یادداشت را در بخش هاب مربوطه قرار دهید و سپس منتشر کنید.

این فرم، فیلدهای پشتیبانی را به‌جای جملات کامل، با نام‌های کوتاه آن‌ها مانند version و releasedOn نمایش می‌دهد.

نکات مهم

• ترتیب. یادداشت‌ها بر اساس جدیدترین تاریخ انتشار فهرست می‌شوند.
• به تفکیک هاب. صفحه هر هاب، یادداشت‌های بخش و موضوعات خودش را نمایش می‌دهد.
• RSS. مخاطبان می‌توانند لاگ تغییرات را از طریق فید دنبال کنند. این فید در آدرسی از سایت شما که به help/release-notes.rss/ ختم می‌شود قرار دارد.
• داده‌های جستجو. هر یادداشت برای موتورهای جستجو به‌عنوان یک مقاله فنی همراه با نسخه آن معرفی می‌شود. هیچ تضمینی برای نمایش ویژه در نتایج جستجو وجود ندارد.
• برای مخاطب خود بنویسید. تغییرات را به زبان ساده و ملموس برای آن‌ها بیان کنید.

پرسش‌ها

مطالب مرتبط

• مشکلات شناخته‌شده و اطلاعیه‌ها
• هاب‌های راهنما
• مرکز راهنما و مستندات
• استخدام، رویدادها و موارد دیگر