ভালো সফটওয়্যার ডকুমেন্টেশন, প্রোগ্রামার এবং টেস্টারদের জন্য স্পেসিফিকেশন ডকুমেন্টেশন, অভ্যন্তরীণ ব্যবহারকারীদের জন্য প্রযুক্তিগত নথি, অথবা ম্যানুয়াল এবং শেষ ব্যবহারকারীদের জন্য সাহায্য ফাইল, ব্যবহারকারীদের সফটওয়্যারের বৈশিষ্ট্য এবং ফাংশন বুঝতে সাহায্য করবে। ভাল ডকুমেন্টেশন হল ডকুমেন্টেশন যা নির্দিষ্ট, পরিষ্কার এবং প্রাসঙ্গিক, ব্যবহারকারীর প্রয়োজনীয় সমস্ত তথ্যের সাথে। এই নিবন্ধটি আপনাকে প্রযুক্তিগত ব্যবহারকারীদের এবং শেষ ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন লিখতে নির্দেশ দেবে।
ধাপ
2 এর পদ্ধতি 1: প্রযুক্তিগত ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন লেখা
ধাপ 1. কোন তথ্য অন্তর্ভুক্ত করতে হবে তা জানুন।
স্পেসিফিকেশন ডকুমেন্ট ইন্টারফেস ডিজাইনার, প্রোগ্রামার যারা কোড লেখেন এবং সফটওয়্যার পারফরমেন্স যাচাই করেন এমন পরীক্ষকদের জন্য রেফারেন্স ম্যানুয়াল হিসাবে ব্যবহৃত হয়। যে তথ্যগুলি অন্তর্ভুক্ত করা দরকার তা তৈরি করা প্রোগ্রামের উপর নির্ভর করবে, তবে নিম্নলিখিতগুলি অন্তর্ভুক্ত করতে পারে:
- অ্যাপ্লিকেশনটিতে গুরুত্বপূর্ণ ফাইল, যেমন ডেভেলপমেন্ট টিমের তৈরি ফাইল, প্রোগ্রাম চলাকালীন অ্যাক্সেস করা ডেটাবেস এবং তৃতীয় পক্ষের অ্যাপ্লিকেশন।
- ফাংশন/সাবরুটিন, ইনপুট এবং আউটপুট ভ্যালু ব্যবহারের ব্যাখ্যা সহ ফাংশন এবং সাবরুটিন।
- প্রোগ্রাম ভেরিয়েবল এবং ধ্রুবক, এবং কিভাবে তারা ব্যবহার করা হয়।
- সামগ্রিক প্রোগ্রাম কাঠামো। ড্রাইভ-ভিত্তিক প্রোগ্রামগুলির জন্য, আপনাকে প্রতিটি মডিউল এবং লাইব্রেরির বর্ণনা দিতে হতে পারে। অথবা, যদি আপনি একটি ওয়েব-ভিত্তিক প্রোগ্রামের জন্য একটি ম্যানুয়াল লিখছেন, তাহলে আপনাকে ব্যাখ্যা করতে হবে যে প্রতিটি পৃষ্ঠা কোন ফাইল ব্যবহার করে।
পদক্ষেপ 2. ডকুমেন্টেশনের কোন স্তর উপস্থিত থাকা উচিত এবং প্রোগ্রাম কোড থেকে আলাদা করা যায় তা নির্ধারণ করুন।
প্রোগ্রাম কোডে যত বেশি টেকনিক্যাল ডকুমেন্টেশন অন্তর্ভুক্ত করা হয়েছে, এটি আপডেট এবং রক্ষণাবেক্ষণ করা তত সহজ হবে, সেইসাথে প্রোগ্রামের বিভিন্ন সংস্করণ ব্যাখ্যা করাও সহজ হবে। কমপক্ষে, প্রোগ্রাম কোডের ডকুমেন্টেশনে ফাংশন, সাবরুটিন, ভেরিয়েবল এবং ধ্রুবক ব্যবহার অন্তর্ভুক্ত থাকতে হবে।
- যদি আপনার সোর্স কোড লম্বা হয়, আপনি একটি হেল্প ফাইলে ডকুমেন্টেশন লিখতে পারেন, যা তারপর নির্দিষ্ট কিওয়ার্ড দিয়ে ইনডেক্স বা সার্চ করা যায়। পৃথক ডকুমেন্টেশন ফাইলগুলি দরকারী যদি প্রোগ্রাম লজিক বিভিন্ন পৃষ্ঠায় বিভক্ত হয় এবং সমর্থন ফাইলগুলি অন্তর্ভুক্ত করে, যেমন একটি ওয়েব অ্যাপ্লিকেশন।
- কিছু প্রোগ্রামিং ল্যাঙ্গুয়েজ (যেমন জাভা, ভিজ্যুয়াল বেসিক.নেট, অথবা সি#) এর নিজস্ব কোড ডকুমেন্টেশন স্ট্যান্ডার্ড আছে। এই জাতীয় ক্ষেত্রে, স্ট্যান্ডার্ড ডকুমেন্টেশন অনুসরণ করুন যা অবশ্যই সোর্স কোডে অন্তর্ভুক্ত করা উচিত।
পদক্ষেপ 3. উপযুক্ত ডকুমেন্টেশন টুল নির্বাচন করুন।
কিছু ক্ষেত্রে, ডকুমেন্টেশন টুল ব্যবহৃত প্রোগ্রামিং ভাষা দ্বারা নির্ধারিত হয়। C ++, C#, Visual Basic, Java, PHP এবং অন্যান্য ভাষার নিজস্ব ডকুমেন্টেশন টুল আছে। যাইহোক, যদি না হয়, ব্যবহৃত সরঞ্জামগুলি প্রয়োজনীয় ডকুমেন্টেশনের উপর নির্ভর করবে।
- একটি ওয়ার্ড প্রসেসর যেমন মাইক্রোসফট ওয়ার্ড ডকুমেন্ট টেক্সট ফাইল তৈরির জন্য উপযুক্ত, যতক্ষণ ডকুমেন্টেশন সংক্ষিপ্ত এবং সহজ। জটিল টেক্সট দিয়ে দীর্ঘ ডকুমেন্টেশন তৈরি করতে, বেশিরভাগ টেকনিক্যাল লেখকরা অ্যাডোব ফ্রেমমেকারের মতো একটি বিশেষ ডকুমেন্টেশন টুল বেছে নেন।
- সোর্স কোড ডকুমেন্ট করার জন্য হেল্প ফাইল তৈরি করা যেতে পারে একটি সাপোর্ট ফাইল জেনারেটর প্রোগ্রাম দিয়ে, যেমন RoboHelp, Help and Manual, Doc-to-Help, MadCap Flare, বা HelpLogix।
2 এর পদ্ধতি 2: শেষ ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন লেখা
পদক্ষেপ 1. ম্যানুয়াল তৈরির অন্তর্নিহিত ব্যবসায়িক কারণগুলি জানুন।
যদিও সফটওয়্যার ডকুমেন্টেশনের মূল কারণ হল ব্যবহারকারীদের অ্যাপ্লিকেশনটি কিভাবে ব্যবহার করতে হয় তা বুঝতে সাহায্য করা, অন্যান্য অনেক কারণ রয়েছে যা ডকুমেন্টেশন তৈরি করতে পারে, যেমন বিপণন বিভাগকে অ্যাপ্লিকেশন বিক্রি করতে সাহায্য করা, কোম্পানির ভাবমূর্তি উন্নত করা এবং প্রযুক্তিগত সহায়তা হ্রাস করা খরচ কিছু ক্ষেত্রে, প্রবিধান বা অন্যান্য আইনি প্রয়োজনীয়তা মেনে চলার জন্য ডকুমেন্টেশন প্রয়োজন।
যাইহোক, ডকুমেন্টেশন একটি ইন্টারফেসের জন্য একটি ভাল বিকল্প নয়। যদি কোনো অ্যাপ্লিকেশনের কাজ করার জন্য অনেক ডকুমেন্টেশনের প্রয়োজন হয়, তাহলে এটি আরও স্বজ্ঞাত হওয়ার জন্য ডিজাইন করা উচিত।
পদক্ষেপ 2. ডকুমেন্টেশনের লক্ষ্য দর্শকদের জানুন।
সাধারণত, সফ্টওয়্যার ব্যবহারকারীদের তাদের দ্বারা ব্যবহৃত অ্যাপ্লিকেশনগুলির বাইরে কম্পিউটার জ্ঞান সীমিত। তাদের ডকুমেন্টেশনের চাহিদা পূরণের বিভিন্ন উপায় রয়েছে:
- সফ্টওয়্যার ব্যবহারকারীর শিরোনামে মনোযোগ দিন। উদাহরণস্বরূপ, সিস্টেম অ্যাডমিনিস্ট্রেটর সাধারনত বিভিন্ন কম্পিউটার অ্যাপ্লিকেশন বুঝতে পারে, যখন সেক্রেটারি শুধুমাত্র ডেটা প্রবেশ করার জন্য যে অ্যাপ্লিকেশনগুলি ব্যবহার করে তা জানে।
- সফ্টওয়্যার ব্যবহারকারীদের দিকে মনোযোগ দিন। যদিও তাদের অবস্থানগুলি সাধারণত সম্পাদিত কাজগুলির সাথে সামঞ্জস্যপূর্ণ, ব্যবসায়ের স্থানের উপর নির্ভর করে এই পদগুলিতে বিভিন্ন কাজের চাপ থাকতে পারে। সম্ভাব্য ব্যবহারকারীদের সাক্ষাত্কারের মাধ্যমে, আপনি জানতে পারেন যে তাদের কাজের শিরোনাম সম্পর্কে আপনার মূল্যায়ন সঠিক কিনা।
- বিদ্যমান নথিতে মনোযোগ দিন। সফ্টওয়্যার কার্যকারিতা ডকুমেন্টেশন এবং স্পেসিফিকেশন ব্যবহারকারীদের তাদের ব্যবহার করার জন্য কি জানতে হবে তা দেখাতে পারে। যাইহোক, মনে রাখবেন যে ব্যবহারকারীরা প্রোগ্রামের "অভ্যন্তরীণ" জানতে আগ্রহী হতে পারে না।
- কোন কাজটি সম্পন্ন করতে কি লাগে এবং কোন কাজটি সম্পন্ন করার আগে তার কি প্রয়োজন তা জেনে নিন।
পদক্ষেপ 3. ডকুমেন্টেশনের জন্য উপযুক্ত বিন্যাস নির্ধারণ করুন।
সফ্টওয়্যার ডকুমেন্টেশন 1 বা 2 ফরম্যাটে সাজানো যেতে পারে, যেমন রেফারেন্স বই এবং ম্যানুয়াল। কখনও কখনও, দুটি ফর্ম্যাট একত্রিত করা একটি ভাল সমাধান।
- রেফারেন্স ফরম্যাটগুলি সমস্ত সফ্টওয়্যার বৈশিষ্ট্য, যেমন বোতাম, ট্যাব, ক্ষেত্র এবং ডায়ালগ বক্স এবং কীভাবে তারা কাজ করে তা বর্ণনা করতে ব্যবহৃত হয়। কিছু হেল্প ফাইল এই ফরম্যাটে লেখা হয়, বিশেষ করে সেগুলি যা প্রসঙ্গ সংবেদনশীল। যখন ব্যবহারকারী একটি নির্দিষ্ট স্ক্রিনে সাহায্যে ক্লিক করেন, তখন ব্যবহারকারী প্রাসঙ্গিক বিষয় পাবেন।
- সফটওয়্যারের সাহায্যে কিভাবে কিছু করতে হয় তা ব্যাখ্যা করার জন্য ম্যানুয়াল ফরম্যাট ব্যবহার করা হয়। ম্যানুয়ালগুলি সাধারণত প্রিন্ট বা পিডিএফ ফরম্যাটে থাকে, যদিও কিছু সাহায্য পৃষ্ঠায় কিছু জিনিস কীভাবে করতে হয় তার নির্দেশাবলী অন্তর্ভুক্ত থাকে। (সাধারণত, ম্যানুয়াল ফরম্যাটগুলি প্রসঙ্গ সংবেদনশীল নয়, তবে প্রসঙ্গ সংবেদনশীল বিষয়গুলির সাথে যুক্ত হতে পারে)। হ্যান্ডবুকগুলি সাধারণত একটি গাইড আকারে থাকে, একটি বিবরণে সম্পাদিত কাজগুলির সংক্ষিপ্তসার এবং ধাপে ধাপে একটি গাইড ফর্ম্যাট করা হয়।
ধাপ 4. ডকুমেন্টেশনের ধরন ঠিক করুন।
ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন নিম্নলিখিত ফর্ম্যাটের একটি বা একাধিক প্যাকেজ করা যেতে পারে: মুদ্রিত ম্যানুয়াল, পিডিএফ ফাইল, সাহায্য ফাইল, বা অনলাইন সাহায্য। প্রতিটি ধরণের ডকুমেন্টেশন আপনাকে সফটওয়্যারের ফাংশন কিভাবে ব্যবহার করতে হয় তা দেখানোর জন্য ডিজাইন করা হয়েছে, সেটা গাইড হোক বা টিউটোরিয়াল। অনলাইন ডকুমেন্টেশন এবং হেল্প পেজে বিক্ষোভ ভিডিও, টেক্সট এবং স্ট্যাটিক ইমেজ অন্তর্ভুক্ত থাকতে পারে।
অনলাইন হেল্প এবং সাপোর্ট ফাইলগুলি কীওয়ার্ড ব্যবহার করে ইনডেক্স করা এবং অনুসন্ধান করা উচিত যাতে ব্যবহারকারীরা দ্রুত তাদের প্রয়োজনীয় তথ্য খুঁজে পেতে পারে। যদিও একটি হেল্প ফাইল জেনারেটর অ্যাপ্লিকেশন স্বয়ংক্রিয়ভাবে একটি সূচক তৈরি করতে পারে, তবুও এটি সুপারিশ করা হয় যে আপনি সাধারণভাবে অনুসন্ধান করা কীওয়ার্ড ব্যবহার করে নিজে একটি সূচক তৈরি করুন।
পদক্ষেপ 5. উপযুক্ত ডকুমেন্টেশন টুল নির্বাচন করুন।
ফাইলের দৈর্ঘ্য এবং জটিলতার উপর নির্ভর করে মুদ্রিত ম্যানুয়াল বা পিডিএফ একটি ওয়ার্ড প্রসেসিং প্রোগ্রাম যেমন ওয়ার্ড বা ফ্রেমমেকারের মতো উন্নত টেক্সট এডিটর দিয়ে তৈরি করা যেতে পারে। সাহায্য ফাইল তৈরির প্রোগ্রামের সাহায্যে সাহায্য ফাইলগুলি লেখা যেতে পারে, যেমন RoboHelp, Help and Manual, Doc-to-Help, Flare, HelpLogix, বা HelpServer।
পরামর্শ
- প্রোগ্রাম ডকুমেন্টেশনের টেক্সট এমনভাবে গঠন করা উচিত যাতে এটি পড়তে সহজ হয়। ছবিটি যথাসম্ভব উপযুক্ত পাঠ্যের কাছাকাছি রাখুন। বিভাগ এবং বিষয়গুলি যুক্তিযুক্তভাবে ডকুমেন্টেশন ভেঙে দিন। প্রতিটি বিভাগ বা বিষয় একটি নির্দিষ্ট সমস্যা, উভয় টাস্ক এবং প্রোগ্রাম বৈশিষ্ট্য বর্ণনা করা উচিত। সম্পর্কিত সমস্যাগুলি লিঙ্ক বা রেফারেন্স তালিকা দিয়ে ব্যাখ্যা করা যেতে পারে।
- এই প্রবন্ধে বর্ণিত প্রতিটি ডকুমেন্টেশন টুল স্ক্রিনশট মেকার প্রোগ্রাম দ্বারা পরিপূরক হতে পারে, যেমন SnagIt যদি আপনার ডকুমেন্টেশনে একাধিক স্ক্রিনশট প্রয়োজন হয়। অন্যান্য ডকুমেন্টেশনের মতো, ব্যবহারকারীকে "প্রলুব্ধ" করার পরিবর্তে অ্যাপটি কীভাবে কাজ করে তা ব্যাখ্যা করতে স্ক্রিনশটও অন্তর্ভুক্ত করা উচিত।
- শৈলীতে মনোযোগ দেওয়া খুব গুরুত্বপূর্ণ, বিশেষত যদি আপনি শেষ ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন লিখছেন। "ব্যবহারকারী" এর পরিবর্তে "আপনি" সর্বনাম ব্যবহারকারীদের সম্বোধন করুন।
