ম্যানুয়াল - কিভাবে আপ টু ডেট?

Question

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

Comments

আমরা কি মুদ্রিত বা অন-লাইন ম্যানুয়ালগুলিতে কথা বলছি? এটি গ্রহণ করতে পারে বিভিন্ন ফর্মের কমপক্ষে কয়েকটি দম্পতি রয়েছে।

— জেবি কিং

অনলাইন (পিডিএফ) ম্যানুয়াল

— ব্রায়ান

Answer 1

আমি ম্যানুয়ালটি আপডেট করব:

1. প্রতিটি বড় রিলিজের জন্য, এবং
2. গুরুত্বপূর্ণ নতুন বৈশিষ্ট্যগুলি স্থিতিশীল হয়ে উঠলে এবং পর্যাপ্ত পরিপক্ক হয়ে উঠলে আপনি জানেন যে তারা প্রতি পাঁচ মিনিটে পরিবর্তন করবে না।

Answer 2

(পিডিএফ) ম্যানুয়ালটি যে কোনও সময় আপডেট করুন যে কোনও কোড পরিবর্তন ম্যানুয়ালটিতে থাকা নির্দেশাবলীকে বদলে দেবে - মুক্তির প্রক্রিয়াটির ম্যানুয়াল অংশটি আপডেট করে ফেলুন

ব্যবহারকারীরা কীভাবে পণ্যটি ব্যবহার করবেন এবং পণ্যটি কীভাবে পরিবর্তিত হয় তা জানাতে যদি ম্যানুয়ালটির উপর নির্ভর করে তবে ম্যানুয়ালটির প্রাসঙ্গিক বিভাগটিও পরিবর্তন হওয়া উচিত

Comments

সুতরাং কর্মীদের উপর যদি কোনও প্রযুক্তিগত লেখক না থাকে, তবে এটি নিজে আপডেট করবেন?

— ব্রায়ান

@ 0 এ 0 ডি - যদি আপনার কোনও লেখক না থাকে তবে আপনার কাছে পছন্দ নেই, যদি না পরীক্ষা-নিরীক্ষা বা সহায়তা করতে পারে এমন স্টাফ যারা না করতে পারে।

— জেফো

আমার প্রকল্পগুলির অংশ হিসাবে আমার কাছে দস্তাবেজ 'উত্স ফাইল' রয়েছে। এগুলি সর্বদা কোড হিসাবে একই সময়ে আপডেট হয়। এগুলি রিলিজ সহ সংস্করণযুক্ত এবং প্রকল্পের বাকী ফাইলগুলির মতো একই সোর্স ম্যানেজমেট সরঞ্জামগুলি ব্যবহার করে পরিচালনা করা হয় (যান মার্চুরিয়াল!)। একটি প্রকল্পের সাথে যাওয়ার জন্য আমার কাছে বেশ মানসম্পন্ন ম্যানুয়াল রয়েছে এবং এগুলি একইভাবে পরিচালিত হয় (ব্যবহারকারী গাইড, কনফিগারেশন / ইনস্টলেশন গাইড, রিলিজ নোট এবং আমাদের নিজস্ব প্রযুক্তিগত রেফ / স্পেস নথি)।

Answer 3

2010 সালে আমরা এখনও মুদ্রিত ডকুমেন্টেশন উল্লেখ করছি? কেন? ;)

সমস্ত গুরুত্বের সাথে ডকুমেন্টেশন (হয় "এফ 1" অ্যাপ্লিকেশন সহায়তা, পিডিএফ, বা অনলাইন ডকুমেন্টেশন) প্রতিটি একক রিলিজের অংশ হওয়া উচিত। জিরো অজুহাত। এটি "প্রকাশ করা" সহজ। আইএমও হিসাবে, ইস্যুগুলি জানা এবং সংশোধন হওয়ার সাথে সাথে প্রকাশের মাঝেও নিয়মিত (অনলাইন এবং পিডিএফ) ডকুমেন্টেশন আপডেট না করার কোনও অজুহাত নেই। এটির জন্য সমান স্তরের কিউএ প্রয়োজন নেই - এমনকি কাছাকাছিও নয়।

Answer 4

আমি ধরে নিই যে আপনি শেষ ব্যবহারকারী নথির কথা বলছেন about ডকুমেন্টেশন লিখনটি @ in এর একটি ব্যথা এবং যখন আমি আমার বিপরীতকে বোঝানোর জন্য কিছু কৌশল তৈরি করেছি, তখনও আমার তাতে সমস্যা আছে। আমি এটি পরিচালনা করার চেষ্টা করি:

আপনার ডিডে ডকুমেন্টেশনের আপডেট সংহত করুন ( সংজ্ঞায়িত সংশোধন )

এটি নিশ্চিত করবে যে প্রতিটি ব্যবহারকারীর গল্প সমাপ্তির শেষে আপনার ডকুমেন্টেশনগুলি আপ টু ডেট থাকবে।

এখানে আমরা লিখেছি সংজ্ঞা। আমি মূল বিন্যাসগুলি রাখার চেষ্টা করেছি, যাতে আপনি ধারণাটি পান। এটি হোয়াইটবোর্ডে রাখা একটি এ 4 পৃষ্ঠা।

---------- 8 <------------ এখানে কাটুন ------------ 8 <----------

আলোচ্য নয়

"সম্পন্ন" সংজ্ঞা

• 80% ইউনিট পরীক্ষার কভারেজ সহ কোড, সংগ্রহস্থলে প্রতিশ্রুতিবদ্ধ

• স্ক্রীনশট প্রযোজ্য হলে (1024x728, 395x281, 170x121 এবং 729x329)

• প্রযোজ্য হলে ফিচারের বর্ণনা (50 টি অক্ষর, 100 টি চর)

• সম্পূর্ণ শেষ ব্যবহারকারী ডকুমেন্টেশন

• নতুন ফাইলটি সঠিকভাবে আপডেট হয়েছে

---------- 8 <------------ এখানে কাটুন ------------ 8 <----------

অবশ্যই আপনি ডকুমেন্টেশনে একটি পর্যালোচনা প্রক্রিয়া যুক্ত করতে পারেন। আমাদের যেহেতু আমাদের মধ্যে কেউই ইংরেজী স্পিকার নয়।

এর সংজ্ঞা সংজ্ঞাটির একটি সুবিধা হ'ল প্রতিটি ব্যবহারকারীর গল্প সমাপ্তির শেষে আপনার পণ্যটি সম্ভাব্যভাবে শিপযোগ্য able

এই একের সাথে এই কৌশলটি ব্যবহার করুন ।

Answer 5

আমার সংস্থায়, আমাদের সাধারণত 3 ধরণের প্রকাশ থাকে:

1. ইঞ্জিনিয়ারিং রিলিজ - নির্দিষ্ট কিছু গ্রাহকের জন্য মূলত হট ফিক্স বা কিছু বৈশিষ্ট্য কেবলমাত্র নির্দিষ্ট গ্রাহককে তাত্ক্ষণিক ভিত্তিতে অনুরোধ করেছে।
2. মাইনর রিলিজ - বাগ ফিক্স, ইনক্রিমেন্টাল সাপোর্ট
3. প্রধান প্রকাশ - নতুন বৈশিষ্ট্য সমর্থন ইত্যাদি

সংজ্ঞা অনুসারে, মেইল ​​রিলিজের অবশ্যই অনলাইন এবং অফলাইন উভয় জায়গায় প্রাসঙ্গিক ডকুমেন্টেশন থাকতে হবে। আমাদের ট্র্যাকিং সিস্টেমটি নিশ্চিত করে যে ডকুমেন্টেশন চেকলিস্টের একটি অংশ।

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

ইঞ্জিনিয়ারিং প্রকাশগুলি ডকুমেন্টেশন ছাড়াই করতে পারে। কিছু অনানুষ্ঠানিক ব্যবহারের নোট শুরু করার জন্য যথেষ্ট ভাল হওয়া উচিত।

Answer 6

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