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