কার্যকরী প্রযুক্তিগত ডকুমেন্টেশন লেখার কৌশল

আমি 1999 সাল থেকে এক বা অন্য ধরণের প্রযুক্তিগত লেখার কাজ করছি, যখন আমি ইসরায়েলের কেফার সাবাতে আলটেক ল্যান্সিংয়ের R&D শাখার জন্য QA করছিলাম। তখন আমরা উদ্ভাবনী, অডিও-সম্পর্কিত ডিভাইসগুলি রাখতাম যেমন (হাঁপা) USB অডিও ডিভাইসগুলি যা Windows ME এবং 2000-এ কাজ করেছিল৷ সেগুলি বগি ছিল এবং সেগুলি সেট আপ করা আজকের মতো সোজা জিনিস ছিল না৷

আমাদের ডক্স দরকার ছিল।

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

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

এটি 24 বছর হয়ে গেছে, এবং তারপর থেকে আমি একগুচ্ছ প্রকল্পের জন্য ডকুমেন্টেশন করেছি। স্কেল বেড়েছে, এবং আমি এই ধরণের প্রকল্পগুলিকে যেভাবে দেখি তা যথেষ্ট পরিবর্তিত হয়েছে।

ভাল ডক্সের জন্য কী তৈরি করে সে সম্পর্কে আমার কিছু চিন্তা আছে এবং আপনি আগ্রহী হলে আমি সেগুলি আপনার সাথে শেয়ার করতে চাই।

মূল ডকুমেন্টেশন ধারণা

আমি আরও কংক্রিট নিয়মগুলির একটি সেট দিয়ে শুরু করতে চাই যা আমি বিশ্বাস করি যে একটি ডকুমেন্টেশন পণ্যের সাফল্যের জন্য গুরুত্বপূর্ণ।

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

• আপনি যখন পারেন তখন ডক্সের একটি গল্প বলা উচিত - কারণ একটি ব্যক্তিগত, সম্পর্কিত কাজের সেট যা একটি গল্প বলে আপনার ব্যবহারকারীর জন্য নির্দেশের একটি বিমূর্ত সেটের চেয়ে বেশি আকর্ষণীয় এবং স্মরণীয় হবে৷

• দস্তাবেজগুলি অনুসন্ধানযোগ্য হওয়া উচিত - কারণ গুরুত্ব সহকারে: এটি একটি নো-ব্রেইনার। যদি আপনার ডক্সে জিনিসপত্র খুঁজে পাওয়া সহজ না হয়, তাহলে আপনার ব্যবহারকারীরা তাদের যা প্রয়োজন তা খুঁজে পাবে না।

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

• ডক্স পরীক্ষা করা উচিত - কারণ আপনি নিশ্চিত হতে পারেন যে সবকিছু ঠিক আছে, কিন্তু প্রকৃত ব্যবহারকারী ছাড়া, অন্য কোনো পণ্যের মতো, আপনি নিশ্চিতভাবে জানতে পারবেন না। এটি পরীক্ষা করুন এবং আবার পরীক্ষা করুন।

  
  

হলিস্টিক ডক্সগুলি ভালভাবে ডিজাইন করা পণ্য

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

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

যখন আমি একটি টেকনিক্যাল রাইটিং প্রজেক্টের কাছে যাই, তখন এটি এই বিস্তৃত দৃষ্টিভঙ্গির সাথে যে এটি একটি ব্যবহারকারীর কী প্রয়োজন। আমি মনে করি ডক্স সম্পর্কে চিন্তা করার এটাই সঠিক উপায়: সামগ্রিকভাবে। দস্তাবেজগুলি একটি সু-সংজ্ঞায়িত জিনিস নয় এবং ভালগুলি তৈরি করতে আপনাকে নমনীয় হতে হবে৷

আমার কাছে, এর মানে হল আপনি যতটা সম্ভব আপনার ব্যবহারকারীদের সম্পর্কে চিন্তা করতে হবে। আপনি মঞ্জুর করে কিছু নিতে পারবেন না বা আপনি কিছু গোষ্ঠীর ব্যবহারকারীকে এমনভাবে হতাশ করতে যাচ্ছেন যা আপনার ব্র্যান্ড, আপনার পণ্য বা আপনার ব্যবসাকে এমনভাবে নেতিবাচকভাবে প্রভাবিত করবে যা থেকে ফিরে আসা কঠিন।

আপনার নথিগুলি প্রায়শই আপনার ব্যবহারকারীদের জন্য একটি মেক-ইট-অর-ব্রেক-ইট অভিজ্ঞতা।

আপনি যদি একটি ভাল কাজ করেন, আপনার ব্যবহারকারীরা সফলভাবে আপনার পণ্য ব্যবহার করবে, এবং আপনার ব্র্যান্ডের চ্যাম্পিয়ন হবে। যদি আপনি না করেন, তারা সম্ভবত আপনার পণ্যটি আর কখনও ব্যবহার করবে না কারণ আপনার ডক্স তাদের মনে খারাপ স্বাদ রেখে গেছে। তারা অন্যদেরও জানাবে। ভাল বিপণন এখানে শুরু হয়, তাই মনে রাখবেন.

ভালো ডক্স তৈরি করা

ভাল ডক্স তৈরি করার অর্থ হল যে আপনি অন্য কোনও পণ্য প্রক্রিয়ার মতো আপনার ডক্স তৈরির সাথে যোগাযোগ করতে হবে।

তোমার দরকার:

• আপনি কেন আপনার নথি তৈরি করছেন তা জানুন
• আপনার লক্ষ্য শ্রোতা কে জানুন
• তাদের ব্যথার পয়েন্টগুলি কী তা জানুন
• সময়ের সাথে সাথে আপনার ডক্স উন্নত করুন

আসুন এই প্রতিটি ঘনিষ্ঠভাবে কটাক্ষপাত করা যাক.

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

আপনার ডক্সের ফর্ম কে এটি ব্যবহার করবে তার দ্বারা বর্ণনা করা হয়েছে৷ এটা কি অনলাইন? এটি একটি অ্যাপের সাথে বান্ডিল? এটা কি মুদ্রিত? প্রতিটি ব্যবহারকারীর বেস অন্য কিছুর প্রয়োজন হবে এবং আপনাকে তারা কারা তা জানতে হবে।

আপনার কাজ হল আপনার প্রতিটি ব্যবহারকারীর জন্য কী কঠিন তা খুঁজে বের করা এবং তাদের নির্দিষ্ট সমস্যার সমাধান করে এমন তথ্যপূর্ণ বিষয়বস্তুর মাধ্যমে তাদের ফানেল করার জন্য আপনার ডক্স তৈরি করা।

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

আপনার ডক্স আপনার সাফল্যের একটি অবিচ্ছেদ্য অংশ

ডক্সগুলি কতটা সমালোচনামূলকভাবে গুরুত্বপূর্ণ তা আমি সহজভাবে আন্ডারস্কোর করে সংক্ষিপ্ত করব। তাদের ছাড়া, আপনার ব্যবহারকারীরা তাদের নিজস্ব এবং নিজেদের জন্য প্রতিরোধ করা আবশ্যক.

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

দস্তাবেজগুলি তাদের নিজস্বভাবে একটি গুরুতর উপ-পণ্য, এটি একটি বিনিয়োগ, এবং আপনার বিস্তৃত পণ্য কৌশলের অংশ হতে হবে৷