نوشتن راهنمای عملیات با هوش مصنوعی
کاری رو که تیم انجام داده به دستورالعمل مرحلهای تبدیل کنید. نفر بعد میدونه هر قدم با کیه، از کجا بفهمه درست پیش رفته و اگر لازم شد چطور برگرده.
نوشتن راهنمای عملیات با هوش مصنوعی وقتی به درد میخوره که یک کار تکراری رو همیشه یک نفر از تیم انجام میده و بقیه فقط پیام «انجام شد» رو میبینن. اسکیل writing-runbooks کمک میکنه از روی مراحل و بررسیهایی که واقعا انجام شدن، راهنمایی بنویسید که نفر بعد بتونه بهش تکیه کنه. نسخه ابزار، مجوز لازم و نتیجهای که باید بعد از اجرا ببینید، قبل از شروع کار مشخص میشن.
مثلا شاید برای انتشار یک گزارش اول باید فایل تازه رو جایگزین کنید و بعد نشانی نسخه قبلی رو بردارید. اگر ترتیب عوض بشه، خواننده مدتی به هیچ نسخهای دسترسی نداره. در راهنما میتونید دلیل ترتیب رو کنار همون قدم بنویسید تا کسی که وسط کار عجله داره مجبور نشه بین چند صفحه دنبال جواب بگرده. جایی هم که هنوز امتحان نشده، با برچسب پیشنویس مشخص میمونه.
کاربردها
- یک راهنمای اجرا بسازید که اول مسیر کوتاه رو نشون بده و بعد هر قدم رو با جزییات توضیح بده.
- برای هر پیشنیاز نصب، نسخه مورد انتظار و روشی رو که تیم برای بررسیش استفاده کرده بنویسید.
- بخش عیبیابی خطا رو از پیامی شروع کنید که کاربر واقعا میبینه تا بشه با همون عبارت پیداش کرد.
- برای هر تغییر، راه برگشت رو ثبت کنید و اگر برگشت امکان نداره پیامد این محدودیت رو توضیح بدید.
- در مهاجرت از یک نسخه به نسخه بعد، اسم قدیمی و جدید هر تنظیم رو کنار هم بذارید تا تطبیقشون راحت باشه.
نصب و استفاده
- مجموعه technical-writer رو در ایجنتتون نصب کنید یا این اسکیل رو همراه راهنمای technical-writing بگیرید. مراحل امتحانشده و نتیجه مورد انتظار رو در اختیارش بذارید.
- بگید «از روی یادداشتهای انتشار، راهنمای اجرای تیم رو بنویس. مشخص کن کدوم قدم دسترسی عملیاتی میخواد و کجا میشه نتیجه رو بررسی کرد.»
- پیشنویس رو با کسی که این کار رو انجام داده مرور کنید. هر قدم یا راه برگشتی که هنوز بررسی نشده باید همین وضعیت رو در متن داشته باشه.
سوالات متداول
منبع
ساخته riekelt. نام اصلی: writing-runbooks، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub