ডকুমেন্টেশনের সঠিক পরিমাণ নির্ধারণ করা


10

আমি বর্তমানে যেখানে কাজ করি সেখানে সাধারণ পন্থাটি হ'ল -

যতটা সম্ভব ডকুমেন্টেশন এড়ানো

কোনও ভিন্ন দলের প্রয়োজন হলে কেবলমাত্র নথি করুন

কেবলমাত্র স্পষ্টতার জন্য, আমি কোড-ডকুমেন্টেশন বোঝাতে চাইছি না - এটি আমরা করি, আমি ডিজাইন প্রক্রিয়াটিকে ঘিরে সমস্ত ডকুমেন্টেশন বোঝাতে চাইছি - যদি এটি ইউএমএল বা ডিবি স্কিমাস, শ্রেণি চিত্র এবং স্পেসিফিকেশন এবং পছন্দগুলি সহ শব্দ নথি থাকে।

আমি ডকুমেন্ট না করার জন্য আমার বসের কারণ তালিকা করব:

  1. এটি সময় সাপেক্ষ - বাস্তবায়নের উপর ফোকাস focus
  2. যদি ডিজাইন পরিবর্তন হয় - তবে ডকুমেন্টেশনটি পরিবর্তন হওয়া উচিত, ডাবল ঝামেলা
  3. শেষ পর্যন্ত আপনি কেবল কয়েকশ পৃষ্ঠাগুলি পাবেন যে কেউ পড়তে চায় না এবং কেউ সত্যই সম্পাদনা করে না তাই সময়মতো এটি পুরানো হয়ে যাবে
  4. এটি একটি ব্যথা - সত্যিই কেউ এটি করতে চায় না

এখন আমি বুঝতে পেরেছি যে আমরা দ্রুত কাজ করি, তবে আমি এখানে আসার এবং কিছুটা পুরানো কোডে ডাইভিং করার সময়টিও মনে করি, কিছুই বুঝতে পারি না।

প্রকৃতপক্ষে, আমি এখনও এই পুরানো কোডটির বেশিরভাগটি পাই না এবং কখনও কখনও আমি যখন দেখি তখন বিভিন্ন বিকাশকারীদের কাছ থেকে অনেকগুলি প্যাচগুলি ছোট টুইটগুলি করার চেষ্টা করছে।

আমি সত্যিই মনে করি ডকুমেন্টিংয়ের অভাব এই ধরণের প্যাচগুলি এবং বিস্তৃত অর্থে সিস্টেম বোঝার অভাবকে উত্সাহিত করে।

আমার প্রশ্নটি হ'ল:

আমরা কীভাবে দলিলগুলিতে ভারসাম্য বজায় রাখতে পারি যাতে আমরা দলের মধ্যে অবিচ্ছিন্ন জ্ঞান প্রচার করি এবং এখনও দ্রুত এবং দক্ষ হতে পারি?


আমার জায়গায় আমার একই সমস্যা রয়েছে - আমার দলটি কোড মন্তব্য লিখলেও না!
ম্যাটড্যাভি

1
তারা কমপক্ষে ন্যূনতম প্রয়োজনীয়তা এবং চশমা নথি করে? যদি তা না হয় তবে আপনি কীভাবে জানবেন যে আপনি যদি প্রস্তুত পণ্যটির সাথে তুলনা করার প্রয়োজন নেই তবে আপনি সঠিক জিনিসটি কোড করেছেন?
হতাশ

বিশেষত আধুনিক ভাষার সাথে প্রযুক্তিগত ডকুমেন্টেশন কোড ডকুমেন্টিংয়ের পরে অনেক বেশি গুরুত্বপূর্ণ। কোড স্ব বর্ণনামূলক হতে হবে।
একে_ফেব্রুয়ারি

যদিও অতিরিক্ত ডকুমেন্টেশন এড়াতে এটি একটি ভাল ধারণা, আপনার মনিব সমস্ত ভুল কারণে এটি করেন।
খ্রিস্টান রাউ

আপনার সংস্থাটি যে শিল্পটি চালাচ্ছে সে সম্পর্কে আপনি কি ধারণা দিতে পারেন? কিছু শিল্পের ন্যূনতম স্তরের কীভাবে ডকুমেন্টেশন প্রয়োজন তার আইনী প্রয়োজনীয়তা রয়েছে।
তেহনিয়ত

উত্তর:


5

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

এটি প্রদর্শিত হয় যে আপনার বর্তমান দলের সদস্যদের তাদের স্মৃতি সম্পর্কে কিছু অবাস্তব প্রত্যাশা রয়েছে বা তারা তাদের লেখার দক্ষতার জন্য লজ্জিত, এবং অনুশীলন করতে রাজি নয়।

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

ডকুমেন্টেশনের কাছে যাওয়ার সর্বোত্তম উপায় হ'ল এটি যেমন আপনি যান ঠিক তেমন লেখার মতো পরীক্ষার কোডটি। এটি কয়েকটি আশ্চর্যজনক যে কীভাবে কয়েকটি প্রাক লিখিত টেম্পলেটগুলি (শিরোনাম, কোডের স্টাব ইত্যাদির সাহায্যে) ডকুমেন্টেশনকে আরও সহজ এবং দ্রুত করতে পারে। এইভাবে আপনি পরিবর্তনটি যেমন ঘটবে তেমন ক্যাপচার করতে পারবেন এবং সময়ের সাথে সাথে আপনার coverাকতে কম জমি থাকবে। আপনি এইভাবে আরও দক্ষ, যেহেতু আপনার প্রয়োজন হিসাবে ডকুমেন্টেশনগুলিকে উল্লেখ করতে পারেন এবং আপনি এটি পথ পরিবর্তন করে। উদাহরণস্বরূপ, একটি উইকিতে এটি করা আপডেটগুলি সহজ করে তোলে এবং সর্বশেষতম এবং সর্বশ্রেষ্ঠ একই স্থানে অনলাইনে থাকাকালীন আপনি ডকুমেন্ট সংস্করণ সম্পর্কিত সমস্যাগুলি এড়াতে পারবেন এবং আপনি যেসব ব্যক্তিকে এটি পড়তে হবে তাদের লিঙ্কগুলি প্রেরণ করতে পারেন।

আপনি যদি ডকুমেন্টিংয়ের জন্য কিছুটা সময় ব্যয় করেন তবে আপনি সমস্ত দ্রুত কাজ করবেন, বিশেষত যখন কোনও নতুন দলে যোগ দেবেন, যেহেতু তাদের সমস্ত কিছু বের করার জন্য সমস্ত সময় ব্যয় করতে হবে না। স্টাফ আউট আউট করা আমাদের কাজের একটি মজাদার অংশ, তবে আপনি যখন উত্পাদন ঠিক করার জন্য তাড়াহুড়ো করে তা করতে মজা পাবেন না। আমরা সবাই আরও দু'টি নোট লিখলে আমরা সবাই অনেক সময় বাঁচাতে চাই।

আপনার দলের পরীক্ষার, বা পরীক্ষার কোড লেখার ক্ষেত্রে একই সমস্যা রয়েছে? যদি তা না হয় তবে এটি সহজ বিক্রয় হবে।

আপনার ডকুমেন্টেশন বিভিন্ন উপায়ে কার্যকর:
1) আপনি এখন, এবং আপনার সহকর্মীদের জন্য, যেমন আপনি প্রকল্পটিতে কাজ করেন।

2) আপনার গ্রাহকদের। ডকুমেন্টেশন থাকা (ডায়াগ্রাম সহ) যা আপনি ব্যবহারকারীদের দেখাতে পারেন তা সভাগুলিতে আলোচনা সহজ করে তোলে, বিশেষত যদি আপনি জটিল সিস্টেমগুলি নিয়ে আলোচনা করছেন। এমনকি ডকুমেন্টেশন অসম্পূর্ণ থাকলেও এটি থেকে শুরু করার জায়গা।

3) আপনার কাজের উত্তরাধিকারী ব্যক্তিদের কাছে (যা তিন বছরেও আপনি হতে পারেন)। আমার অনেক ছোট সহকর্মী মনে করেন তারা চিরকালের জন্য জিনিসগুলি মনে রাখবেন। আমি জানি আমি এটি লিখতে না পারলে এই সপ্তাহের আগে এটি মনে রাখব না। ডকুমেন্টেশন থাকা আপনার অর্ধেক দিন ব্যয় করা থেকে আপনি কীভাবে কোনও কিছুকে কাঠামোগত গঠন করেছিলেন তা পুনরুদ্ধার করে এবং এটি আবার বের করে আনে ves

৪) আপনার এবং অন্যদের কাছে পরিস্থিতি রাজনৈতিক বা বিতর্কিত হয়ে উঠলে। যে কেউ মিটিংয়ে নোট নেন, নিজেকে জাগ্রত রাখতে এবং বিরক্তির সাথে লড়াই করার জন্য, আমি প্রায়শই সিদ্ধান্তের লিখিত সংস্করণে একাই হয়েছি। যে ব্যক্তি এটি লিখেছিল সে বিবাদটি জয় করে। এটি পরের বারের মতো এটির কথা মনে রাখবেন "মনে রাখবেন যে আমরা এই শীতকালে সম্মেলনের চারটি সম্মেলনে বসেছিলাম, যখন আমরা এক্স পেরিয়ে যাচ্ছিলাম? ফ্রেড সেখানে ছিলেন, এবং অ্যাকাউন্টিংয়ের লোকটি কে?"


1
# 3 পয়েন্টের জন্য +1। আমার নিজের ব্যক্তিগত ডকুমেন্টেশন আমাকে বেশ কয়েকবার বাঁচিয়েছে।
ব্র্যান্ডন

আমি কোড হিসাবে একই গিট রেপোতে আমার নিক্ষেপ করি, সাধারণত মার্কডাউন-এ (মাঝে মাঝে ল্যাটেক্সে, যখন কিছুটা গণিত জড়িত থাকে)।
ট্রিগ

4

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

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

বেশিরভাগ জিনিসের মতো, আমি মনে করি আপনার কাজটি সম্ভবত কাজ করতে পারে এমন ন্যূনতম পরিমাণে করা উচিত। এটি যদিও কিছুই হিসাবে একই জিনিস না।


এটি একটি দুর্দান্ত পরামর্শ। কিছু উইকি সামগ্রী একটি .rtf নথিতে রফতানি করার অনুমতি দেয়। পিএইচবি-র জন্য প্রায় নিখুঁত।
তেহনিয়ত

আমরা এক্সকিউই ব্যবহার করি, বিশেষত পিডিএফ, আরটিএফ এবং এইচটিএমএলে নথি তৈরি করার দক্ষতার জন্য। দুষ্ট ভাল।
জেনিফার এস

2

সঠিক ডকুমেন্টেশন লেখার জন্য সময় বরাদ্দ থেকে আপনি বাঁচতে পারবেন না। আপনাকে কতটা কাজ দেওয়া হচ্ছে তার উপর নির্ভর করে আপনি এটি ভারসাম্য বজায় রাখুন তবে আপনি যা করেছেন তা ডকুমেন্ট করার জন্য আপনার সময়টির 15-15% ভাল রেখে দিন। আপনার ম্যানেজার সহ দলের প্রত্যেককেই এই বোর্ডে উঠতে হবে, অন্যথায় আপনি কেবল অন্যের সুবিধার্থে ডকুমেন্টিং করবেন এবং বিনিময়ে কিছুই পাবেন না। ডকুমেন্টিং অবশ্যই আপনার বিকাশ প্রক্রিয়ার একটি অবিচ্ছেদ্য অঙ্গ হতে হবে।


1

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

এছাড়াও, আপনার কোড বেসের প্রতিটি বড় উপাদান সামগ্রিক উচ্চ স্তরের আর্কিটেকচার বজায় রাখতে ভুলবেন না। নতুন দলের সদস্যদের অন্তর্ভুক্ত করা খুব সহজ করে তোলে।

অবশেষে, যখনই আপনি একটি বেড়ানোর সমাধান সংযুক্ত করেন, একটি মন্তব্য থেকে আপনার বাগ ডাটাবেসের সাথে লিঙ্ক করুন - খুব দরকারী।


1

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

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

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

ইউএমএল দুর্দান্ত, সত্যই সহায়ক তবে মডেলিং / বিকাশের পর্যায়ে আরও নমনীয়তা এবং আরও পুনরাবৃত্তি দেওয়ার জন্য আমাদের মডেল চালিত ডিভিলিপমেন্ট ব্যবহার বন্ধ করা উচিত। শ্রেণি চিত্রটি কোড থেকে লাইভ আপডেট হয় এবং ডকুমেন্টেশন সবসময় নির্ভুল এবং কেবলমাত্র একটি ক্লিকের মাধ্যমে উপলব্ধ available আমি কোনও সরঞ্জামের উল্লেখ করব না তবে আপনি জাভা এবং গ্রহণটি ব্যবহার করলে আমি কোন সরঞ্জামটি ব্যবহার করব তা খুঁজে পাওয়া সহজ :-)

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.