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