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