লক্ষ্য দর্শকের প্রয়োজন অনুসারে ডকুমেন্টেশনগুলি সংগঠিত করুন।
আপনার ক্ষেত্রে প্রাথমিক শ্রোতা আপাতদৃষ্টিতে সফ্টওয়্যার বিকাশকারী। এখানে বিবেচনা করা অংশগুলি হ'ল এটির বিভিন্ন "উপ-শ্রোতাদের" সম্বোধন করা:
- ওহে বিশ্ব.
যারা এটির স্বাদ দ্রুত পেতে আগ্রহী তারা কেবল নমুনা অ্যাপ্লিকেশনটি তৈরি করে এটি কীভাবে দেখায় তা চালান।
মাইএসকিউএল "15 মিনিটের নিয়ম" দ্বারা সম্বোধিত মত দর্শকের মতো চিন্তা করুন :
... কোনও ব্যবহারকারী মাইএসকিউএল ডাউনলোড করতে শেষ হওয়ার 15 মিনিট পরে চালাতে সক্ষম হবে।
- প্রাথমিক ধারনা।
কাজ করার সফ্টওয়্যার উত্পাদন শুরু করার জন্য প্রয়োজনীয় জিনিসগুলি শিখতে আগ্রহী ছেলেদের জন্য।
- উন্নত বিষয়।
বিকাশকারীদের জন্য ইতিমধ্যে সুপরিচিত এবং মৌলিকগুলির সাথে অনুশীলন করেছেন, এর বাইরে কী আছে তা জানতে আগ্রহী। মেনস্ট্রিম গুরুত্বপূর্ণ বিষয়গুলির মধ্যে আবৃত করা হয়নি প্রাথমিক ধারনা ।
- স্টাইল গাইড / প্রস্তাবিত অনুশীলনসমূহ।
আপনি কীভাবে জিনিসগুলি করার পরামর্শ দিচ্ছেন সেই বিষয়ে আগ্রহীদের জন্য বিষয়গত পরামর্শ এবং গাইডেন্স guidance
এটি আপনার ক্ষেত্রে যথেষ্ট পরিমাণ শ্রোতা থাকতে পারে কিনা তা ইঙ্গিত দেয় না, সুতরাং বিবেচনার বিকল্পগুলি হ'ল এডভান্সড বিষয়গুলির অংশ / পরিশিষ্ট হিসাবে অন্তর্ভুক্ত করা বা এমনকি এটিকে পুরোপুরি বাদ দেওয়া।
- Quirks।
মূলধারার বাইরে অস্পষ্ট বিষয়গুলি আপনার দর্শকদের বেশ সীমিত ভগ্নাংশের পক্ষে আগ্রহী হতে পারে। উদাহরণস্বরূপ, যদি আপনার উত্তরাধিকারের লাইন থাকে, বা উত্তরাধিকার / মাইগ্রেশন / উত্তরাধিকারের সাথে আন্তঃব্যবহারের মতো জিনিস থাকে তবে এটি এখানে রাখুন। নির্দিষ্ট "বহিরাগত" পরিবেশে কিছু ফাংশনের জন্য যদি কিছু পার্শ্ব প্রতিক্রিয়া থাকে তবে তা এই অংশে যায়।
আপনার গৌণ শ্রোতারা ম্যানুয়ালটির রক্ষণাবেক্ষণকারী। এই ছেলেরা কীভাবে আপনার প্রাথমিক শ্রোতার জন্য জিনিসগুলি কাজ করে তা ভাঙ্গতে পারে বা ভাঙতে পারে, যাতে আপনি তাদের প্রয়োজনীয়তা এবং সমস্যাগুলি আরও ভালভাবে যত্ন নিতে পারেন।
ম্যানুয়ালটিতে যদি কিছু সন্দেহজনক / দ্বিধাগ্রস্ত হয় তবে কী হবে? যদি এটি সক্রিয় হয় যে নির্দিষ্ট ধারণাটির পুরো ব্যাখ্যাটি সেই ম্যানুয়ালটিকে পড়া খুব কঠিন করে তুলবে? যদি ম্যানুয়ালটির সেই বিশেষ সংস্করণে ভুল হয় তবে কী হবে?
রক্ষণাবেক্ষণকারীদের জন্য দুটি বিষয় বিবেচনা করতে হবে:
- প্রযুক্তিগত / আনুষ্ঠানিক স্পেসিফিকেশন।
ম্যানুয়ালটিতে যখনই প্রশ্নবোধক / দ্বিধাহীন / বিষয় ব্যাখ্যা করা শক্ত হবে, পাঠককে সেই বিষয়ে একটি কঠোর এবং স্পষ্ট, "অফিসিয়াল" বিবৃতি দেওয়ার জন্য নির্দিষ্ট অনুচ্ছেদে উল্লেখ করা যেতে পারে। কঠোর এবং সম্পূর্ণ (এবং সম্ভবত বিরক্তিকর) ভাষার বাক্য গঠনের বিবরণ সেখানে আরও ভাল যাবে। নির্দিষ্টকরণের
জন্য প্যারামাউন্ট বিবেচনাগুলি প্রযুক্তিগত নির্ভুলতা এবং সম্পূর্ণতা, এমনকি যদি এগুলি পঠনযোগ্যতার ব্যয়েই আসে।
- অনলাইন পরিপূরক।
কিছু URL টি সংরক্ষণ করুন এবং আপনার প্রকাশিত প্রতিটি নথির শুরুতে রেখে দিন, যাতে ছেলেরা ভাবছেন যে তারা কী পড়েছে তা সেখানে যেতে পারে (ম্যানুয়াল রক্ষণাবেক্ষণকারীদের পরিবর্তে) এবং ভুলটি ব্যাখ্যা করতে পারে।
ত্রুটি-বিচ্যুতি> মৌলিক উপাদানসমূহ> রিলিজ ২.২> টাইপো ২৮ পৃষ্ঠায়, দ্বিতীয় বাক্যটি ভাগ্য দিয়ে শুরু হয় , পরিবর্তে লকটি পড়ুন ।
লক করার কৌশল, কর্মক্ষমতা সম্পর্কিত বিবরণগুলির মতো ধারণাগুলি যেখানে আপনি আশা করেন লক্ষ্য শ্রোতাদের এটির প্রয়োজনীয়তা রয়েছে (আংশিকভাবে সম্ভব) অন্তর্ভুক্ত করা উচিত।
উদাহরণস্বরূপ ম্যানুয়াল রক্ষণাবেক্ষণকারীরা আপাতদৃষ্টিতে আনুষ্ঠানিক নির্দিষ্টকরণের লক এবং লক করার সম্পূর্ণ, সঠিক বিবরণে আগ্রহী হবেন - এটি সেখানে রাখুন। মৌলিক বা উন্নত বিষয়গুলির পাঠকরা নির্দিষ্টকরণ থেকে নেওয়া ওভারভিউ / পরিচয় / গাইডে আগ্রহী হতে পারে এবং তাদের প্রয়োজনীয়তা অনুসারে ইত্যাদি etc.
আপনার মতো অন্যান্য ভাষার জন্য সরবরাহ করা রেফারেন্স ডকুমেন্টেশনের তুলনামূলক অধ্যয়নের ব্যবস্থা করা সহায়ক হতে পারে। যারা আগে এটি করেছে এবং কীভাবে তারা কীভাবে ভুলগুলি এড়াতে পারে তা শিখিয়ে লাভ করার অভিজ্ঞতা অর্জনে এই অধ্যয়নের লক্ষ্য রাখুন।
শেষটি কিন্তু সর্বনিম্ন নয়, সফ্টওয়্যার বিকাশের অনুরূপ কোনও উপায়ে ডকুমেন্টেশন ডেভলপমেন্ট সেটআপ করার বিষয়টি বিবেচনা করুন। আমি বলতে চাইছি সংস্করণ নিয়ন্ত্রণ, নিয়মিত প্রকাশ, ইস্যু ট্র্যাকিং, মানের নিশ্চয়তা ইত্যাদির মতো জিনিসগুলি আপনি কিছুটা আপস করতে চাইতে পারেন যদিও এটি যদি প্রমাণিত হয় যে আপনার প্রযুক্তিগত লেখক (গুলি) এর মতো স্টাফগুলিতে সত্যিই আরামদায়ক নন। নিখুঁত বিকাশের প্রক্রিয়াটির জন্য আমরা "বিনিময়ে" কৃপণ সামগ্রী পেতে চাই না, তাই না?