আমাদের দলে, চৌকস হওয়ার পর থেকে আমরা সংকীর্ণ হওয়ার চেষ্টা করেছি এবং বুঝতে পারি যে কতটা ডকুমেন্টেশন আসলে প্রয়োজন actually আমরা এখন অবধি যা শিখেছি তা আপনার সাথে ভাগ করে নিতে পারি।
অন্য যে কোনও কিছুর আগে, নিবন্ধটি চটজলদি / চর্বিযুক্ত ডকুমেন্টেশনে পড়তে ভুলবেন না । খুব ভাল পড়া।
দ্বিতীয়ত, আমি আপনাকে দৃ strongly়ভাবে গল্পের প্রাথমিক কাজ শেষে নকশা নথি উত্পাদন পুনর্বিবেচনা পরামর্শ দিতে পরামর্শ দেব। আমরা এর আগেও চেষ্টা করেছি এবং এটি অপচয় হিসাবে প্রমাণিত হয়েছে। শেষ প্রকাশের মাঝামাঝি আমরা গল্পের কোড সরবরাহ করার পরে কেবল ডিজাইন ডক্স আপডেট করার সিদ্ধান্ত নিয়েছি। এবং এখন আমি এমনকি খুব শীঘ্রই চিন্তা করছি।
কোডিংয়ের আগে আপনি কেন ডিজাইন ডক্স করতে চান তা নিজেকে জিজ্ঞাসা করতে হবে। আমাদের জন্য এই কারণগুলি ছিল:
- একটি দল হিসাবে আমাদের গল্পটি কীভাবে ডিজাইনটির উপর প্রভাব ফেলবে তা বুঝতে হবে।
- নতুন (বা অস্থায়ী) সদস্যরা যখন দলে যোগ দেয় বা কোডে ফিরে আসে যখন এক বছরেরও বেশি সময় ধরে কেউ কাজ করেনি তখন ডিজাইনের ডকুমেন্টগুলি থাকা কার্যকর প্রমাণিত হয়েছে। সুতরাং কোডটি কীভাবে কাজ করে তা বুঝতে সহায়তা করতে তারা সাংগঠনিক মেমরির জন্য দরকারী।
- নকশার নথিগুলি রক্ষণাবেক্ষণ ইঞ্জিনিয়ারদের জন্য দরকারী যাদের মুক্তির পরে কোডটির সমস্যা সমাধানের প্রয়োজন হতে পারে।
(1) সন্তুষ্ট করার জন্য আপনাকে আসল নকশা নথি তৈরি করতে হবে না। আপনার দলের কোডিংয়ের আগে একটি নকশা ফেজ থাকা উচিত, তবে সেই পর্বটি হোয়াইটবোর্ড বা ন্যাপকিনের সামনে 15 মিনিটের সেশনের মতোই সহজ হতে পারে। আপনাকে এমন একটি আসল দলিল তৈরি করার দরকার নেই যা কেবল ডিজাইনের পরিবর্তনগুলি নিয়ে আলোচনার জন্য লিখতে ঘন্টা (যদি দিন না হয়) সময় নেয়।
(2) বা (3) বর্তমান গল্পের বিকাশের সময় প্রয়োজন হয় না এবং সম্ভবত পরবর্তী কয়েকটি পুনরাবৃত্তির জন্য তাদের প্রয়োজন হবে না।
এছাড়াও মনে রাখবেন যে প্রতিবার কোনও দলের সদস্য ডিজাইন ডকগুলি লিখছেন / আপডেট করছেন, সেই সময়টি সেই কোডটি লেখা হচ্ছে না। আপনি যখন আসল কোডের আগে ডকগুলি লেখেন তখন প্রায় 100% সম্ভাবনা থাকে যে সেগুলি আপডেট করার প্রয়োজন হবে কারণ আপনি একবার কোডিং ডিজাইন শুরু করলে সর্বদা পরিবর্তন হয়ে যায়। এবং কোডের পরেও আপনি ডিজাইন ডকগুলি লিখলেও, যেমনটি আমাদের দলটি শিখে গেছে, পরবর্তী গল্পগুলি থেকে পুনরুদ্ধার করার পরেও নকশাটি পরিবর্তিত হয়।
সুতরাং আমি কি সুপারিশ করব:
- প্রাথমিকভাবে পর্যাপ্ত অস্থায়ী ডিজাইন / মডেল উত্পাদন করুন যাতে আপনার টিম কোডিংয়ের আগে বুদ্ধিমান কথোপকথন করতে পারে। এগুলি রাখার আশা করবেন না এবং এগুলিকে আনুষ্ঠানিককরণে সময় নষ্ট করবেন না।
- কারওর প্রয়োজন পড়লে কেবল অফিসিয়াল ডিজাইনের ডকুমেন্টেশন তৈরি করুন (যেমন আপনার দলের সাংগঠনিক মেমরির আসল প্রয়োজন আছে)
- স্থিতিশীল করা হয়েছে এমন কোডগুলিতে কেবল ডিজাইনের ডকুমেন্টেশন তৈরি করুন। এমন কোনও মডিউল নথিভুক্ত করার চেষ্টা করছে না যা প্রতিটি পুনরাবৃত্তিতে পরিবর্তিত হতে থাকে।
- ডিজাইনের নথি তৈরি করুন যা সম্পূর্ণরূপে একটি মডিউল বর্ণনা করে (বা পণ্যের অংশ)। অতীতে আমরা ডিজাইন ডকগুলি লিখতাম যা পরিবর্তনগুলি করতে হবে তা নথিভুক্ত করে। এই দস্তাবেজগুলি মুক্তি পাওয়ার সাথে সাথে পুরোপুরি মূল্যহীন ছিল।
- দস্তাবেজটি খুব উচ্চ-স্তরের রাখুন। আপনি যদি 20 টি পৃষ্ঠাগুলি আর্কিটেকচার এবং খুব উচ্চ-স্তরের নকশাকে আচ্ছাদন করে লিখে থাকেন তবে সেই দস্তাবেজটি ক) প্রকৃতপক্ষে অন্য লোকেরা পড়বে এবং খ) লোকেরা আপনার কোডের সাধারণ বিন্যাসের সাথে পরিচিত হতে সহায়তা করবে। বিশদগুলির জন্য লোকেরা সরাসরি কোডে যেতে পারে। আপনি যদি 700 টি পৃষ্ঠাগুলির বিশদ বিবরণ লিখে থাকেন তবে সেগুলি প্রায়শই বাস্তবতার সাথে মেলে না, কারও পক্ষে এটি পড়া খুব বেশি এবং ভবিষ্যতে যখনই পরিবর্তন আসবে আপনি 20 এর পরিবর্তে 700 পৃষ্ঠাগুলি বজায় রাখতে এবং আপডেট করতে পারবেন।