আমরা ডকুমেন্টেশনের গুণমান কিভাবে মূল্যায়ন করেছি

হ্যালো, হাবর! আমার নাম লেশা, আমি আলফা-ব্যাঙ্কের পণ্য দলের একজনের সিস্টেম বিশ্লেষক। এখন আমি আইনি সত্তা এবং স্বতন্ত্র উদ্যোক্তাদের জন্য একটি নতুন অনলাইন ব্যাংক তৈরি করছি।

এবং আপনি যখন একজন বিশ্লেষক হন, বিশেষত এই জাতীয় চ্যানেলে, আপনি ডকুমেন্টেশন ছাড়া কোথাও যেতে পারবেন না এবং এটির সাথে কাজ বন্ধ করতে পারবেন। এবং ডকুমেন্টেশন এমন কিছু যা সবসময় অনেক প্রশ্ন উত্থাপন করে। কেন ওয়েব অ্যাপ্লিকেশন বর্ণনা করা হয় না? কেন স্পেসিফিকেশন নির্দেশ করে যে পরিষেবাটি কীভাবে কাজ করা উচিত, কিন্তু এটি মোটেও সেরকম কাজ করে না? কেন এটা শুধুমাত্র দুই ব্যক্তি, যাদের একজন লিখেছেন, স্পেসিফিকেশন বুঝতে পারেন?

যাইহোক, ডকুমেন্টেশন সুস্পষ্ট কারণে উপেক্ষা করা যাবে না. এবং আমাদের জীবন সহজ করার জন্য, আমরা ডকুমেন্টেশনের গুণমান মূল্যায়ন করার সিদ্ধান্ত নিয়েছি। আমরা ঠিক কীভাবে এটি করেছি এবং আমরা কী সিদ্ধান্তে এসেছি তা কাটার নীচে রয়েছে।

ডকুমেন্টেশন মান

পাঠ্যটিতে কয়েক ডজন বার "নতুন ইন্টারনেট ব্যাংক" পুনরাবৃত্তি না করার জন্য, আমি NIB লিখব। এখন আমাদের এক ডজনেরও বেশি দল রয়েছে যারা উদ্যোক্তা এবং আইনি সত্তার জন্য NIB-এর উন্নয়নে কাজ করছে। তদুপরি, তাদের প্রত্যেকটি হয় নতুন পরিষেবা বা ওয়েব অ্যাপ্লিকেশনের জন্য স্ক্র্যাচ থেকে নিজস্ব ডকুমেন্টেশন তৈরি করে, বা বর্তমানটিতে পরিবর্তন করে। এই পদ্ধতির সাথে, নীতিগতভাবে ডকুমেন্টেশন উচ্চ মানের হতে পারে?

এবং ডকুমেন্টেশনের গুণমান নির্ধারণ করতে, আমরা তিনটি প্রধান বৈশিষ্ট্য চিহ্নিত করেছি।

1. এটা সম্পূর্ণ হতে হবে. এটি বরং অধিনায়কের মতো শোনাচ্ছে, তবে এটি লক্ষ্য করা গুরুত্বপূর্ণ। এটি বাস্তবায়িত সমাধানের সমস্ত উপাদান বিশদভাবে বর্ণনা করা উচিত।
2. এটা বর্তমান হতে হবে. যে, সমাধান নিজেই বর্তমান বাস্তবায়ন অনুরূপ.
3. এটা বোধগম্য হওয়া উচিত. যাতে এটি ব্যবহারকারী ব্যক্তি বুঝতে পারে কিভাবে সমাধানটি বাস্তবায়িত হয়।

সারসংক্ষেপ - সম্পূর্ণ, আপ-টু-ডেট এবং বোধগম্য ডকুমেন্টেশন।

সাক্ষাত্কার

ডকুমেন্টেশনের গুণমান মূল্যায়ন করার জন্য, আমরা যারা সরাসরি এটির সাথে কাজ করে তাদের সাক্ষাৎকার নেওয়ার সিদ্ধান্ত নিয়েছি: NIB বিশ্লেষকরা। উত্তরদাতাদের স্কিম অনুসারে 10টি বিবৃতি মূল্যায়ন করতে বলা হয়েছিল "1 থেকে 5 পর্যন্ত স্কেলে (সম্পূর্ণ অসম্মত - সম্পূর্ণরূপে একমত)"।

বিবৃতিগুলি গুণগত ডকুমেন্টেশনের বৈশিষ্ট্য এবং এনআইবি নথি সম্পর্কিত জরিপ সংকলকদের মতামত প্রতিফলিত করে।

1. NIB অ্যাপ্লিকেশনগুলির জন্য ডকুমেন্টেশন আপ টু ডেট এবং তাদের বাস্তবায়নের সাথে সম্পূর্ণ সামঞ্জস্যপূর্ণ।
2. এনআইবি অ্যাপ্লিকেশনের বাস্তবায়ন সম্পূর্ণ নথিভুক্ত।
3. NIB অ্যাপ্লিকেশনগুলির জন্য ডকুমেন্টেশন শুধুমাত্র কার্যকরী সমর্থনের জন্য প্রয়োজন।
4. কার্যকরী সমর্থনের জন্য জমা দেওয়ার সময় NIB অ্যাপ্লিকেশনগুলির জন্য ডকুমেন্টেশন বর্তমান।
5. NIB অ্যাপ্লিকেশন বিকাশকারীরা তাদের কী বাস্তবায়ন করতে হবে তা বোঝার জন্য ডকুমেন্টেশন ব্যবহার করে।
6. NIB অ্যাপ্লিকেশনগুলি কীভাবে বাস্তবায়িত হয় তা বোঝার জন্য যথেষ্ট ডকুমেন্টেশন রয়েছে।
7. আমি অবিলম্বে NIB প্রকল্পগুলিতে ডকুমেন্টেশন আপডেট করি যদি সেগুলি চূড়ান্ত হয় (আমার দল দ্বারা)।
8. NIB অ্যাপ্লিকেশন বিকাশকারীরা ডকুমেন্টেশন পর্যালোচনা করে।
9. NIB প্রকল্পের জন্য ডকুমেন্টেশন কিভাবে প্রস্তুত করতে হয় সে সম্পর্কে আমার স্পষ্ট ধারণা আছে।
10. আমি বুঝতে পারি কখন NIB প্রকল্পগুলির জন্য ডকুমেন্টেশন লিখতে/আপডেট করতে হবে।

এটা স্পষ্ট যে "1 থেকে 5 পর্যন্ত" উত্তর দিলে প্রয়োজনীয় বিবরণ প্রকাশ নাও হতে পারে, তাই একজন ব্যক্তি প্রতিটি আইটেমের উপর একটি মন্তব্য করতে পারে।

আমরা কর্পোরেট স্ল্যাকের মাধ্যমে এই সব করেছি - আমরা কেবল একটি সমীক্ষা করার জন্য সিস্টেম বিশ্লেষকদের একটি আমন্ত্রণ পাঠিয়েছি। সেখানে 15 জন বিশ্লেষক ছিলেন (9 জন মস্কো থেকে এবং 6 জন সেন্ট পিটার্সবার্গ থেকে)। সমীক্ষা শেষ হওয়ার পর, আমরা 10টি স্টেটমেন্টের প্রতিটির জন্য একটি গড় স্কোর তৈরি করেছি, যা আমরা তখন প্রমিত করেছিলাম।

এখানে কি ঘটেছে.

সমীক্ষায় দেখা গেছে যে যদিও বিশ্লেষকরা বিশ্বাস করেন যে NIB অ্যাপ্লিকেশনের বাস্তবায়ন সম্পূর্ণ নথিভুক্ত, তারা দ্ব্যর্থহীন চুক্তি (0.2) দেয় না। একটি নির্দিষ্ট উদাহরণ হিসাবে, তারা উল্লেখ করেছে যে বিদ্যমান সমাধানগুলি থেকে অনেকগুলি ডেটাবেস এবং সারিগুলি ডকুমেন্টেশন দ্বারা আচ্ছাদিত হয়নি। বিকাশকারী বিশ্লেষককে বলতে সক্ষম যে সবকিছু নথিভুক্ত নয়। কিন্তু থিসিস যে ডেভেলপাররা ডকুমেন্টেশন পর্যালোচনা করে তাও দ্ব্যর্থহীন সমর্থন পায়নি (0.33)। অর্থাৎ বাস্তবায়িত সমাধানের অসম্পূর্ণ বর্ণনার ঝুঁকি থেকে যায়।

প্রাসঙ্গিকতা সহজ - যদিও আবার কোন স্পষ্ট চুক্তি নেই (0,13), বিশ্লেষকরা এখনও প্রাসঙ্গিক ডকুমেন্টেশন বিবেচনা করতে আগ্রহী। মন্তব্যগুলি আমাদের বুঝতে সাহায্য করেছে যে প্রাসঙ্গিকতার সাথে সমস্যাগুলি মাঝখানের তুলনায় প্রায়শই সামনে থাকে। যাইহোক, তারা সমর্থন সম্পর্কে আমাদের কাছে কিছু লেখেনি।

ডকুমেন্টেশন লিখতে এবং আপডেট করার প্রয়োজন হলে বিশ্লেষকরা নিজেরাই বোঝেন কিনা, চুক্তিটি এর নকশা (1,33) সহ অনেক বেশি অভিন্ন (1.07) ছিল। এখানে একটি অসুবিধা হিসাবে উল্লেখ করা হয়েছে ডকুমেন্টেশন বজায় রাখার জন্য অভিন্ন নিয়মের অভাব। অতএব, "কে বনে যায়, কে আগুন কাঠ পায়" মোডটি চালু না করার জন্য, তাদের বিদ্যমান ডকুমেন্টেশনের উদাহরণগুলির উপর ভিত্তি করে কাজ করতে হবে। সুতরাং, একটি দরকারী ইচ্ছা হল নথি পরিচালনার জন্য একটি মান তৈরি করা এবং তাদের অংশগুলির জন্য টেমপ্লেট তৈরি করা।

কার্যকরী সমর্থনের জন্য জমা দেওয়ার সময় NIB অ্যাপ্লিকেশনগুলির জন্য ডকুমেন্টেশন বর্তমান (0.73)। এটি বোধগম্য, কারণ কার্যকরী সহায়তার জন্য একটি প্রকল্প জমা দেওয়ার মানদণ্ডগুলির মধ্যে একটি হল আপ-টু-ডেট ডকুমেন্টেশন। এটি বাস্তবায়ন বোঝার জন্যও যথেষ্ট (0.67), যদিও মাঝে মাঝে প্রশ্ন থেকে যায়।

কিন্তু উত্তরদাতারা যেটির সাথে একমত হননি (মোটামুটি সর্বসম্মতভাবে) তা হল যে NIB অ্যাপ্লিকেশনগুলির জন্য ডকুমেন্টেশন, নীতিগতভাবে, শুধুমাত্র কার্যকরী সমর্থনের জন্য প্রয়োজন (-1.53)। বিশ্লেষকদের প্রায়ই ডকুমেন্টেশনের ভোক্তা হিসেবে উল্লেখ করা হয়। বাকি দল (বিকাশকারী) - অনেক কম প্রায়ই। অধিকন্তু, বিশ্লেষকরা বিশ্বাস করেন যে ডেভেলপাররা ডকুমেন্টেশন ব্যবহার করে না যা তাদের বাস্তবায়ন করতে হবে, যদিও সর্বসম্মতভাবে নয় (-0.06)। যাইহোক, এটি এমন পরিস্থিতিতেও প্রত্যাশিত যেখানে কোড ডেভেলপমেন্ট এবং ডকুমেন্টেশন লেখা সমান্তরালভাবে এগিয়ে যায়।

নীচের লাইন কি এবং কেন আমরা এই সংখ্যা প্রয়োজন?

নথির গুণমান উন্নত করতে, আমরা নিম্নলিখিতগুলি করার সিদ্ধান্ত নিয়েছি:

1. বিকাশকারীকে লিখিত নথি পর্যালোচনা করতে বলুন।
2. যদি সম্ভব হয়, একটি সময়মত ডকুমেন্টেশন আপডেট করুন, আগে সামনে।
3. NIB প্রকল্পগুলি নথিভুক্ত করার জন্য একটি মান তৈরি করুন এবং গ্রহণ করুন যাতে প্রত্যেকে দ্রুত বুঝতে পারে কোন সিস্টেমের উপাদানগুলি এবং ঠিক কীভাবে বর্ণনা করা উচিত। ভাল, উপযুক্ত টেমপ্লেট বিকাশ.

এই সব একটি নতুন স্তরে নথির মান বাড়াতে সাহায্য করা উচিত.

অন্তত আমি তাই আশা.

উত্স: www.habr.com