এই নির্দেশিকাটি সংস্থাগুলিকে আরও ভাল ডকুমেন্টেশনের মাধ্যমে কী ধরণের সমস্যাগুলি সমাধান করা যেতে পারে এবং ডকুমেন্টেশন প্রকল্পগুলির জন্য কীভাবে উপযুক্ত মেট্রিক্স বেছে নেওয়া যায় তা বুঝতে সাহায্য করার উদ্দেশ্যে করা হয়েছে৷
বর্তমান পর্যায়:
ডকুমেন্টেশন উন্নয়ন. টাইমলাইন দেখুন।
আপনার সমস্যা বলুন
একটি মেট্রিক বেছে নেওয়ার আগে, আপনি যে সমস্যার সমাধান করার চেষ্টা করছেন সে সম্পর্কে আপনার ভাল ধারণা রয়েছে তা নিশ্চিত করুন। যতটা সম্ভব নির্দিষ্টভাবে বলো.
- "আমাদের অনবোর্ডিং ডকুমেন্টেশনের জন্য অনুরোধগুলি একত্রিত হতে খুব বেশি সময় নেয়৷ অবদানকারীরা হাল ছেড়ে দেয় এবং চলে যায়৷"
- "আমরা ত্রুটি কোডগুলি বোঝার জন্য অনেকগুলি সমস্যা দেখতে পাচ্ছি।"
- "আমাদের CI/CD পাইপলাইন ফ্ল্যাকি। খুব বেশি পরীক্ষা খারাপভাবে বোঝার কারণে ব্যর্থ হয়।"
- "লোকেরা আমাদের সাপ্তাহিক মিটিংগুলিতে বিরক্তিকর বলে মনে হয়।"
একটি হাইপোথিসিস বিকাশ করুন
কারণ এবং প্রভাব জন্য দেখুন. আপনি যে সমস্যাটি বলেছেন তার কারণ কী হতে পারে? মনে রাখবেন যে সমস্যার একাধিক বা ওভারল্যাপিং কারণ থাকতে পারে।
- "অনবোর্ডিং ডকুমেন্টেশনের জন্য পুল অনুরোধগুলিকে একত্রিত করতে এত সময় লাগে কারণ আমাদের শৈলী সম্পর্কে স্পষ্ট নির্দেশিকা নেই৷ সমালোচকরা হয় পিআর পর্যালোচনা করা বন্ধ করে দেন কারণ তারা জানেন না কি করতে হবে, অথবা তারা ফরম্যাটিং সম্পর্কে অবদানকারীদের সাথে বারবার যান৷ "
- "ব্যবহারকারীদের সমস্যাগুলি খুলতে হবে কারণ তারা ডকুমেন্টেশনে ত্রুটি কোডগুলি সম্পর্কে তথ্য খুঁজে পায় না।"
- "আমাদের CI/CD পরীক্ষা ব্যর্থ হয় কারণ আমরা আমাদের প্রদানকারীর কাছ থেকে পরিকল্পনার সীমাবদ্ধতা এবং সময়সীমার মধ্যে চলে যাই।"
- "লোকেরা আমাদের সাপ্তাহিক মিটিংগুলিতে বিরক্ত হয় কারণ মিটিংগুলি তাদের সময় অঞ্চলে সকাল 5:30 এ।"
একটি সমাধান প্রস্তাব করুন
এটি কি একটি সমস্যা যা নতুন বা আরও ভাল ডকুমেন্টেশন দিয়ে সমাধান করা যেতে পারে?
- "আমাদের যদি একটি স্টাইল গাইড থাকত, কমিটররা তাদের PR জমা দেওয়ার আগে এটি পরীক্ষা করে দেখতে পারত। পর্যালোচকরা জানতেন কী পরীক্ষা করতে হবে। পর্যালোচক এবং অবদানকারীদের বিন্যাস, টোন এবং শৈলী নিয়ে তর্ক করতে হবে না।"
- "যদি আমাদের ত্রুটি কোড ডকুমেন্টেশন থাকে, ব্যবহারকারীরা সমস্যাগুলি খোলার পরিবর্তে সেখানে তাদের উত্তরগুলি খুঁজে পেতে পারে।"
- "হুম, ভালো ডকুমেন্টেশন আমাদের CI/CD সমস্যার সমাধান করবে বলে মনে হয় না।"
- "আমরা একটি নক-নক জোক দিয়ে প্রতিটি মিটিং শুরু করতে পারি! নক-নক জোকসের একটি সংগ্রহ তৈরি করা আমাদের মিটিংটি হাসির সাথে শুরু করতে সাহায্য করবে।"
নির্দিষ্ট পান
আপনি সমস্যা পরিমাপ করতে পারেন?
- "'পিআর একত্রিত করতে খুব বেশি সময় লাগে' এর প্রকৃত অর্থ কী? দুই মাস? দুই সপ্তাহ? কতক্ষণ অবদানকারীরা হাল ছেড়ে দেওয়ার আগে পর্যালোচনার জন্য অপেক্ষা করবেন?"
- "কত ত্রুটি-কোড-সম্পর্কিত সমস্যা 'অত্যধিক সমস্যা'?"
- "হুমমম... 'খুব খারাপ' কতটা খারাপ?"
পরিমাপযোগ্যতা পরীক্ষা করুন
আপনি কিভাবে আপনার প্রস্তাবিত মেট্রিক চেক করবেন? এটা সহজে এবং সঠিকভাবে পরিমাপ করা যাবে? কে পরিমাপ করছে তার উপর কি পরিমাপ নির্ভর করে?
- "আমরা সহজেই পরিমাপ করতে পারি যে কতক্ষণ ধরে একটি পুল অনুরোধ খোলা হয়েছে এবং কতক্ষণ পরে একটি পর্যালোচনার অনুরোধ করা হয়েছে৷ আমরা সত্যিই পরিমাপ করতে পারি না কখন একজন অবদানকারী হাল ছেড়ে দেয়৷"
- "আমরা গণনা করতে পারি কতগুলি সমস্যা 'এরর-কোড' ট্যাগ করা হয়েছে বা ত্রুটি কোড পাঠ্যের জন্য সমস্যার মধ্যে অনুসন্ধান করতে পারি।"
- "আমরা সত্যিই একটি কৌশলী বা সঠিক উপায়ে মানুষের ক্রোধ পরিমাপ করতে পারি না।"
একটি মাধ্যমিক মেট্রিক যোগ করুন
আপনার ডকুমেন্টেশন আপনার সমস্যার সমাধান করছে কিনা তা বুঝতে আপনাকে সাহায্য করবে এমন অন্যান্য মেট্রিক্স আছে কি? আপনার লক্ষ্য মেট্রিক প্রতিটি ক্ষেত্রে একই?
- "দীর্ঘ সময়ের পিআরগুলি পর্যালোচনা করতে আরও সময় নেয়; আমাদের বিভিন্ন আকারের PR-এর জন্য বিভিন্ন থ্রেশহোল্ড থাকা উচিত। আমরা ছোট, মাঝারি, বড় এবং বিশাল PRগুলির জন্য একত্রিত হওয়ার সময় পরিমাপ করতে চাই।"
- "আমাদের ত্রুটি কোড ডকুমেন্টেশন কতগুলি ভিজিট পেয়েছে তা আমরা পরীক্ষা করতে পারি এবং দেখতে পারি যে সেই সংখ্যাটি কম সমস্যার সাথে সম্পর্কযুক্ত কিনা।"
একটি সময়কাল চয়ন করুন
- "আমরা মনে করি ছোট-থেকে-মাঝারি PRs একত্রিত করার জন্য দুই সপ্তাহ একটি যুক্তিসঙ্গত সময়; এবং সমস্ত PR এক মাসের মধ্যে একত্রিত করা উচিত। তাই আমরা প্রতি দুই সপ্তাহে পরিমাপ করব।"
- "প্রতিদিন ত্রুটি-কোড-সম্পর্কিত সমস্যার সংখ্যা আপডেট করার কোন মানে হয় না, কারণ একটি সমস্যা বন্ধ করার জন্য আমাদের সাধারণ সময় এক সপ্তাহ। আমরা এটি সাপ্তাহিক পরিমাপ করব।"
লক্ষ্য স্থির কর
প্রজেক্টটি সফল হয়েছে তা বলার জন্য আপনার নির্বাচিত মেট্রিকে কতটা পরিবর্তন দেখতে হবে? আপনার বেছে নেওয়া মেট্রিকগুলির জন্য পরিমাণগত লক্ষ্য নির্ধারণের কথা বিবেচনা করুন।
- "যদি আমরা এক মাসেরও কম সময়ের মধ্যে প্রতিটি নতুন পিআর বন্ধ করার লক্ষ্য পূরণ করি, তবে এটি একটি সফলতা হবে। যদি আমাদের বড় PR বন্ধ করার গড় সময় দুই সপ্তাহ কমে যায়, তবে এটি একটি বিশাল সাফল্য হবে।"
- "আদর্শভাবে, আমরা কোনও নতুন ত্রুটি-সম্পর্কিত সমস্যা দেখতে পাব না। তবে আমরা যদি ত্রুটি-সম্পর্কিত সমস্যাগুলির 50% হ্রাস দেখতে পাই তবে আমরা আমাদের প্রকল্পকে সফল বলে বিবেচনা করব।"
সংশ্লিষ্ট তথ্য
- আপনার রিপোর্ট-সম্পর্কিত কাজগুলির সাহায্যের জন্য সংস্থার প্রশাসক নির্দেশিকা পড়ুন।