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