কন্টেন্ট

• ধাপ
• পরামর্শ
• প্রয়োজনীয় উপকরণ

ভাল সফ্টওয়্যার ডকুমেন্টেশন - এটি প্রোগ্রামার এবং পরীক্ষকদের জন্য হোক, অভ্যন্তরীণ ব্যবহারকারীদের জন্য প্রযুক্তিগত নথির জন্য বা সফটওয়্যার ম্যানুয়ালগুলির জন্য এবং শেষ ব্যবহারকারীদের জন্য ফাইলগুলির সহায়তা করুন - সফ্টওয়্যারটিতে কাজ করা ব্যক্তিকে এর কার্যকারিতা এবং বৈশিষ্ট্যগুলি বুঝতে সহায়তা করে। ভাল ডকুমেন্টেশন নির্দিষ্ট, সংক্ষিপ্ত এবং প্রাসঙ্গিক, প্রোগ্রামটি ব্যবহার করে লোকেদের সমস্ত গুরুত্বপূর্ণ তথ্য সরবরাহ করে। প্রযুক্তিগত এবং শেষ ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন লেখার জন্য নির্দেশাবলী পড়ুন।

ধাপ

পদ্ধতি 2 এর 1: প্রযুক্তি ব্যবহারকারীর জন্য সফ্টওয়্যার ডকুমেন্টেশন রচনা

1. 

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

2. 

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

3. 

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

পদ্ধতি 2 এর 2: শেষ ব্যবহারকারীদের জন্য সফ্টওয়্যার ডকুমেন্টেশন রচনা

1. 

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

2. 

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

3. 

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

4. 

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

5. 

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

পরামর্শ

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

প্রয়োজনীয় উপকরণ

• সফ্টওয়্যার ডকুমেন্টেশন সরঞ্জাম / সহায়তা ফাইল
• স্ক্রিনশট তৈরির সরঞ্জাম