این راهنما برای کمک به سازمان‌ها در درک اینکه چه نوع مشکلاتی را می‌توان با مستندسازی بهتر حل کرد و نحوه انتخاب معیارهای مناسب برای پروژه‌های مستندسازی کمک می‌کند.
فاز فعلی:
توسعه اسناد و مدارک جدول زمانی را ببینید.
مشکل خود را بیان کنید
قبل از ورود به انتخاب یک معیار، مطمئن شوید که درک خوبی از مشکلی که سعی در حل آن دارید دارید. تا حد ممکن دقیق باشید.
- ادغام شدن درخواست‌های مربوط به اسناد ورود ما خیلی طولانی است. مشارکت‌کنندگان منصرف می‌شوند و می‌روند.»
- "ما می بینیم که مسائل زیادی برای کمک به درک کدهای خطا باز شده است."
- "خط لوله CI/CD ما پوسته پوسته شده است. بسیاری از تست ها به دلایلی که درک درستی ندارند با شکست مواجه می شوند."
- در جلسات هفتگی ما مردم بدخلق به نظر می رسند.
یک فرضیه ایجاد کنید
به دنبال علت و معلول باشید. چه چیزی می تواند باعث مشکلی که بیان کردید باشد؟ به خاطر داشته باشید که مشکلات می توانند دلایل متعدد یا همپوشانی داشته باشند.
- "ادغام درخواست‌های کششی برای مستندات ورود بسیار طول می‌کشد، زیرا ما راهنمایی روشنی در مورد سبک نداریم. بازبین‌ها یا بررسی روابط عمومی را به تعویق می‌اندازند زیرا نمی‌دانند چه کاری باید انجام دهند، یا با مشارکت‌کنندگان در مورد قالب‌بندی به عقب و جلو می‌روند. "
- "کاربران باید مسائل را باز کنند زیرا نمی توانند اطلاعات مربوط به کدهای خطا را در اسناد پیدا کنند."
- آزمایش‌های CI/CD ما با شکست مواجه می‌شوند زیرا با محدودیت‌های طرح و مهلت زمانی ارائه‌دهنده‌مان مواجه می‌شویم.»
- مردم در جلسات هفتگی ما بدخلق هستند زیرا جلسات ساعت 5:30 صبح در منطقه زمانی آنها برگزار می شود.
راه حلی پیشنهاد کنید
آیا این مشکلی است که با مستندات جدید یا بهتر قابل حل است؟
- "اگر ما یک راهنمای سبک داشتیم، متصدیان می‌توانستند قبل از ارسال PR خود آن را بررسی کنند. داوران می‌دانستند چه چیزی را بررسی کنند. داوران و مشارکت‌کنندگان مجبور نیستند درباره قالب‌بندی، لحن و سبک بحث کنند."
- اگر مستندات کد خطا را داشتیم، کاربران می‌توانستند به جای باز کردن مسائل، پاسخ‌های خود را در آنجا پیدا کنند.»
- "هوم، به نظر نمی رسد که مستندات بهتر مشکل CI/CD ما را حل کند."
- "ما می‌توانیم هر جلسه را با یک شوخی ناک شروع کنیم! ایجاد مجموعه‌ای از جوک‌های ناک به ما کمک می‌کند جلساتمان را با لبخند شروع کنیم."
مشخص کنید
آیا می توانید مقدار مشکل را تعیین کنید؟
- "اینکه "ادغام روابط عمومی خیلی طول می کشد" واقعاً به چه معناست؟ دو ماه؟ دو هفته؟ مشارکت کنندگان قبل از تسلیم شدن چقدر منتظر بررسی خواهند بود؟"
- "چند مسائل مربوط به کد خطا "مشکلات خیلی زیاد" هستند؟"
- "هوم ... "خیلی بدخلق" چقدر بد خلق است؟"
قابلیت اندازه گیری را بررسی کنید
متریک پیشنهادی خود را چگونه بررسی می کنید؟ آیا می توان آن را به راحتی و با دقت اندازه گیری کرد؟ آیا اندازه گیری بستگی به این دارد که چه کسی اندازه گیری را انجام می دهد؟
- ما به راحتی می‌توانیم مدت زمانی که یک درخواست بازنگری باز بوده است، و چه مدت از زمان درخواست بازبینی، اندازه‌گیری کنیم.
- ما می‌توانیم شمارش کنیم که چه تعداد از مسائل با برچسب «کد خطا» برچسب‌گذاری شده‌اند یا در شماره‌ها برای متن کد خطا جستجو کنیم.»
- ما واقعاً نمی‌توانیم بدخویی مردم را با درایت یا دقیق بسنجیم.»
یک متریک ثانویه اضافه کنید
آیا معیارهای دیگری وجود دارد که به شما کمک کند بفهمید که آیا اسناد شما مشکل شما را حل می کند؟ آیا معیار هدف شما در هر مورد یکسان است؟
- بررسی روابط طولانی‌تر زمان بیشتری می‌برد؛ ما باید آستانه‌های متفاوتی برای اندازه‌های مختلف روابط عمومی داشته باشیم. ما می‌خواهیم زمان ادغام را برای روابط عمومی‌های کوچک، متوسط، بزرگ و غول پیکر اندازه‌گیری کنیم.»
- ما می‌توانیم بررسی کنیم که اسناد کد خطای ما چند بازدید دریافت کرده است و ببینیم که آیا این تعداد با مشکلات کمتر باز شده مرتبط است یا خیر.
یک دوره زمانی را انتخاب کنید
- "ما فکر می کنیم دو هفته زمان معقولی برای ادغام روابط عمومی های کوچک و متوسط است؛ و همه روابط عمومی ها باید ظرف یک ماه ادغام شوند. بنابراین ما هر دو هفته یک بار اندازه گیری می کنیم."
- "به روز رسانی روزانه تعداد مشکلات مربوط به کد خطا منطقی نیست، زیرا زمان معمول ما برای بستن یک شماره یک هفته است. ما آن را به صورت هفتگی اندازه گیری می کنیم."
اهداف تعیین کنید
برای اینکه بگویید پروژه موفق بوده است، باید چقدر تغییر در معیار انتخابی خود مشاهده کنید؟ برای معیارهایی که انتخاب کردید، اهداف کمی تعیین کنید.
- "اگر ما به هدف خود مبنی بر بستن هر روابط عمومی جدید در کمتر از یک ماه دست یابیم، این یک موفقیت خواهد بود. اگر میانگین زمان ما برای بستن روابط عمومی بزرگ دو هفته کاهش یابد، موفقیت بزرگی خواهد بود."
- "در حالت ایده آل، ما شاهد هیچ مشکل جدید مرتبط با خطا نیستیم. اما اگر شاهد کاهش 50 درصدی در مسائل مربوط به خطا باشیم، پروژه خود را موفق می دانیم."
اطلاعات مربوطه
- راهنمای مدیر سازمان را برای کمک به وظایف مربوط به گزارش خود بخوانید.