ডকুমেন্টেশন হিসাবে-এ-ম্যানুয়াল বনাম ডকুমেন্টেশন যেমন-এ-চেকলিস্ট


17

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

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

  • প্রশ্নে থাকা (উপ) সিস্টেমের উদ্দেশ্য
  • কেন এটি সেই পদ্ধতিতে কনফিগার করা আছে
  • সেটিংস / পদ্ধতিগুলি প্রয়োগ করা হলে ইভেন্টগুলির প্রত্যাশা
  • পদ্ধতিগুলি ব্যর্থ হতে পারে এমন সম্ভাব্য সমস্যা

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

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

সম্পাদনা করুন:

বিভাগে বর্তমানে কোনও হেল্পডেস্কের অবস্থান নেই। ডকুমেন্টেশনের শ্রোতা অন্যান্য প্রশাসকদের বা বিভাগীয় প্রধানের পক্ষে হবে।


1
আপনার সম্পাদনা সম্পর্কিত: আপনার বিভাগের প্রধান যদি প্রতিটি বিট তথ্য বুঝতে চান তবে তিনি সম্ভবত প্রচুর পরিমাণে মাইক্রো ম্যানেজমেন্ট করছেন। আপনার সাইটের সাথে কমপক্ষে একজন ব্যক্তি যে কোনও সময় প্রদত্ত ডকুমেন্টেশন সহ কাজ করতে পারে তা নিশ্চিত করার জন্য কিছু প্রক্রিয়াটি সহজ করার বিষয়ে তার সাথে কথা বলা উচিত। এমন নয় যে সে সব বোঝে।
সার্ভারহরর

উত্তর:


11

আমার লেখার সময় আমি সবসময় দু'টি তিনটি সেট লেখার মধ্যে নিয়েছিলাম । সিস্টেমের আর্কিটেকচার সম্পর্কে অনেক দীর্ঘ পরিশিষ্ট সহ গেট -এয়ার-চেকলিস্ট, অনলাইনে আসার সময় সম্ভাব্য স্টিকিং পয়েন্ট এবং বিমূর্ত নকশার অনুমান সহ system সম্ভাব্য সমস্যাগুলির তালিকা এবং তার সমাধানগুলির পরে একটি সিস্টেম কীভাবে কাজ করে, কেন এটি সেভাবে এটি করে এবং সঠিক দিকনির্দেশক মানুষকে নির্দেশ করার জন্য দরকারী অন্যান্য তথ্য সহ আরও দীর্ঘ একটি বিভাগ রয়েছে should

আমার শেষ কাজটিতে আমাদের ডকটি লিখতে হয়েছিল যাতে স্তর -১ হেল্পডেস্কের লোকেরা জিনিসগুলি ফিরিয়ে আনতে পারে। এই প্রয়োজনীয় চেকলিস্টগুলি, যা সাধারণত লেখার 3 মাসের মধ্যে পুরানো হয়ে যায়। আমাদের যখনই সম্ভব সমস্যা সমাধানের গাইডগুলি লেখার জন্য দৃ urged়ভাবে আহ্বান জানানো হয়েছিল, তবে যখন কন্টিনজেন্সি ট্রি এতে তিনটির বেশি শাখা পেয়ে যায়, আপনি কেবল বিমূর্ত না হয়ে সেই ডকটি লিখতে পারবেন না।

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


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

চেকলিস্ট হিসাবে নথি

এই জাতীয় ডকুমেন্টেশনের জন্য টার্গেট মার্কেট হ'ল সহকর্মীরা যারা কীভাবে কোনও জিনিস করতে চান তা করতে চান। তারা দুটি ধরণের আসে:

  • সহকর্মীরা যারা কেবল কোনও কাজ কীভাবে করতে চান তা জানতে চান এবং পনের পৃষ্ঠা পৃষ্ঠার ম্যানুয়ালটি দিয়ে থাম্ব দেওয়ার সময় নেই এবং নিজের পদক্ষেপগুলি বের করতে পারেন।
  • পদ্ধতিগুলি যা পদক্ষেপগুলিতে মোটামুটি জটিল, তবে কেবল একবারে একবার চালানো দরকার।

অধৈর্য হ'ল প্রথম ধরণের চালক। হতে পারে আপনার সহকর্মী আসলে জানতে চান না কেন আউটপুটটি 90 টি চরিত্রের পার্ল রেজেক্সের মাধ্যমে পাইপ করতে হবে, টিকিটটি বন্ধ করার জন্য এটি হওয়া দরকার। অবশ্যই এই বিবৃতি অন্তর্ভুক্ত করুন, "কেন এই ওয়ার্কফ্লোটি এরকম দেখায় তার বিশদ ব্যাখ্যার জন্য, এই লিঙ্কটি অনুসরণ করুন," যারা জানতে চান না তাদের চেকলিস্টে।

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

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

ম্যানুয়াল হিসাবে নথি

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

এটি এমন ডকুমেন্টেশন যেখানে আমরা এই জাতীয় চিবুকগুলি অন্তর্ভুক্ত করি:

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

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


আপনি দুর্যোগ পুনরুদ্ধার ডকুমেন্টেশন উল্লেখ করেছেন যা একটি চেকলিস্ট হতে হবে।

আমি বুঝতে পারি, আপনার আমার সহানুভূতি রয়েছে।

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

যদি আপনার ডিআর চেকলিস্টটি এমন দেখাচ্ছে:

  1. ডাস্টিন বা ক্যারেনকে কল করুন।
  2. সমস্যাটি ব্যাখ্যা করুন।
  3. ফিরে দাঁড়ানো.

তোমার সমস্যা আছে. এটি একটি চেকলিস্ট নয়, এটি এমন একটি ভর্তি যে এই সিস্টেমটির পুনরুদ্ধারটি এত জটিল an কখনও কখনও আপনি যা করতে পারেন তা হ'ল তবে যদি সম্ভব হয় তবে তা এড়াতে চেষ্টা করুন।

আদর্শভাবে ডিআর ডকুমেন্টেশনে কয়েকটি ভিন্ন জিনিসের জন্য পদ্ধতি চেকলিস্ট রয়েছে:

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

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

কিছু ব্যর্থতার ক্ষেত্রে সরাসরি পুনরুদ্ধার পদ্ধতি থাকে। তাদের নথি। তাদের ডকুমেন্ট করার সময় আপনি এমন কেসগুলি খুঁজে পেতে পারেন যেখানে একটি নির্দিষ্ট ক্রমে কমান্ডের তালিকা প্রবেশ করা হচ্ছে যা স্ক্রিপ্টিংয়ের জন্য দুর্দান্ত ব্যবহারের ক্ষেত্র; এটি একটি 96 পয়েন্ট পুনরুদ্ধার পদ্ধতিটিকে 20 পয়েন্টের মধ্যে রূপান্তর করতে পারে। আপনি ক্রিয়া দ্বারা পুনরুদ্ধার প্রক্রিয়া ক্রিয়াকে ম্যাপ না করা পর্যন্ত আপনি কোনও কিছু স্ক্রিপ্ট করতে পারবেন কিনা তা আপনি কখনই খুঁজে পাবেন না।

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


এটি আমি যে পরিবেশে আছি তার সাথে খুব মিল (মাইনাস হেল্পডেস্ক)। "কেন আমি সেভাবে এটি করেছি" এর জন্য +1
অ্যাভেরি পেইন

@ sysadmin1138, আপনি বলেছিলেন "আমার শেষ কাজটি ছাড়ার সময়, আমি চলে যাওয়ার আগে একটি 100 পৃষ্ঠার 'আমার কাজ কীভাবে করব' ম্যানুয়ালটিতে পরিণত করেছি" । তুমি এটা কেন করছিলে? এটি কি আসলে প্রয়োজনীয়? অন্যথায়, আপনি ইতিমধ্যে চলে যাওয়ায় 100 পৃষ্ঠাগুলি নিয়ে কেন বিরক্ত করবেন?
পেসারিয়ার 4'15

1
@ পেসারিয়রটি ছিল ... 12 বছর আগে। এবং আমি একমাত্র প্রশাসক ছিল যা কিছু জিনিস covering েকে রাখে। এছাড়াও, আমি সেই সংস্থাকে পছন্দ করেছি তাই ক্লিন হ্যান্ড অফ চাই। অন্যান্য সংস্থাগুলি আমাকে 2 সপ্তাহের 'জ্ঞান ভাগ করে নেওয়ার সেশনে' লক করেছে যা একই ধরণের কাজটি করার উদ্দেশ্যে ছিল। শুধুমাত্র কম নির্ভরযোগ্য, যেহেতু মানুষের স্মৃতিশক্তি সত্যই খারাপ।
sysadmin1138

don't have timeহতে পারে don't have time। সামগ্রিকভাবে, পুনরায় ব্যবহারযোগ্য অভিজ্ঞতা!
n611x007

14

প্রকৃতপক্ষে উভয়ই নয়, আমরা ডকুমেন্টেশন যেমন-টেস্টকেস হিসাবে ব্যবহার করি

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

তবে আমাদের ধরণের "ডকুমেন্টেশন যেমন-একটি-চেকলিস্ট" ইনস্টল করা আছে, এটি - উপরে উল্লিখিত হিসাবে - আমরা আমাদের পরিষেবাগুলি ব্যাপকভাবে নিরীক্ষণ করি। একটি কথা আছে:

আপনি যদি এটি পর্যবেক্ষণ না করে থাকেন তবে আপনি এটি পরিচালনা করছেন না

এটি সম্পূর্ণ সত্য, তবে অন্য একটি হওয়া উচিত:

আপনি যদি এটি পর্যবেক্ষণ না করে থাকেন তবে আপনি এটি নথি করছেন না

যখনই আমাদের পরিষেবাগুলি স্থানান্তর করতে হবে আমরা কেবল "পরিষেবা গ্রুপ", "হোস্ট গ্রুপ" রাখি, যা কিছু প্রযোজ্য (আমরা নাগিওগুলি ব্যবহার করি, যেমন আপনি শব্দভাণ্ডার থেকে অনুমান করতে পারেন) খোলা থাকে এবং যতক্ষণ না একটি লাল পয়েন্ট থাকে ততক্ষণ এটি স্থানান্তরিত হয় না isn't যে কোনও পরিষেবাতে

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

  • আমরা জানি কখন এটি ব্যর্থ হয়
  • চেকলিস্টের আরেকটি বিষয়

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

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

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


2
বিকল্প দৃষ্টিকোণের জন্য +1।
অ্যাভেরি পেইন

2
আমি একটি ঝরঝরে ইউটিউব ভিডিও দেখেছি এমন একটি সিস্টেম যা ইন্টিগ্রেশন / গ্রহণযোগ্যতা পরীক্ষা করে এবং স্ক্রিনকাস্ট রেকর্ড করে system youtube.com/watch?v=78mts_sKNGs
jldugger

5

এটি আপনার ডকুমেন্টেশনের জন্য লক্ষ্য দর্শকের উপর নির্ভর করে।

হেল্পডেস্ক (স্তর 1) ধরণের জন্য, একটি চেকলিস্ট হ'ল সঠিক উপায়; অবশ্যই, এটি অনুমান করে যে আপনার বর্ণিত গভীর জ্ঞানের সাথে উচ্চ স্তরের সমর্থন রয়েছে।

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


+1 ডকুমেন্টেশন সর্বদা লক্ষ্য শ্রোতার কথা মাথায় রেখে লেখা উচিত। এ থেকে কিছু পাওয়ার জন্য তারা দস্তাবেজটি পড়ছে ... এটি জ্ঞান বা এটি কীভাবে কিছু করা যায় তা। যদি এটির কীভাবে কিছু করতে হয় যা কিছুটা অতিরিক্ত জ্ঞানের প্রয়োজন হতে পারে আমি অতিরিক্ত জ্ঞানকে একটি পরিশিষ্টের মধ্যে রেখে দেওয়া ভাল উপায় হ'ল।
পল রোল্যান্ড

5

ব্যক্তিগতভাবে আমি চেষ্টা করি এবং ডকুমেন্টেশন যতটা সম্ভব সহজ রাখি। এটি অন্তর্ভুক্ত থাকে:

  • [এক্স] যা করার কথা (প্রয়োজনীয়তা)।
  • [এক্স] কীভাবে একটি উচ্চ স্তরে (নকশা) কাঠামোগত করা হয়েছে।
  • আমি কীভাবে [এক্স] বাস্তবায়িত করেছি (বাস্তবায়নের বিবেচনা)।
  • [এক্স] এর বাস্তবায়নটি কীভাবে মানসম্মত (কর্মক্ষেত্র)।
  • [এক্স] এর সাথে সাধারণ সমস্যা এবং সেগুলি কীভাবে সমাধান করা যায় (সমস্যাগুলি)।

সুতরাং স্বীকারযোগ্যভাবে আমার সাধারণ সমস্যা বিভাগটি কী ঘটেছে তার সংক্ষিপ্ত বিবরণ এবং এটি কীভাবে ঠিক করবেন সে সম্পর্কে ডট পয়েন্ট ওয়াকথ্রুগুলি হতে পারে।

আমি সাধারণত সিস্টেমটিতে পাঠকের কাছ থেকে কিছু জ্ঞান ধরে থাকি (যদি না এটি বিশেষত আরকেন হয়)। আমার বেশিরভাগ প্রযুক্তিগত ডকুমেন্টেশন স্তর 1 বা পরিচালনা পঠনযোগ্য করার জন্য আমার কাছে সময় নেই - তবে একটি ক্লু লেভেল 3 ভাল হওয়া উচিত।


4

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

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

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

সুতরাং, এখন যে আমি এটি লিখেছি, আমি সম্পূর্ণরূপে সম্মত: ধাপে ধাপে চেকলিস্টগুলি কেবল প্রচুর প্রক্রিয়াতে এটি কাটবে না।


3

আমি আপনার সাথে দৃ this়ভাবে একমত (সম্পূর্ণ ডকুমেন্টেশনের পক্ষে) অংশে কারণ আমার পূর্বসূরিদের থাকতে অভ্যস্ত যারা ডক্সে মোটেই আগ্রহী নন। সম্পর্কিত পোস্টগুলিতে যেমন বলা হয়েছে, এটি লিখিতভাবে লেখা কেবল অন্যের পক্ষে ভাল না, তবে আপনাকে আপনার পরিবেশকে আরও সম্পূর্ণরূপে বুঝতে এবং এটি নিজের মনে দৃ solid় করতে সহায়তা করে । এটি নিজেরাই শেষ।

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

স্থিতাবস্থা বক করার জন্য আপনাকে কুদোস।


3

আমি অনেকগুলি নথী করি, আমার কাছে একটি নথির অগ্রাধিকার চেকলিস্টও রয়েছে :-), তবে আমি এমন জিনিসপত্র নথিভুক্ত করব না যা জেনেরিক জ্ঞান হিসাবে বিবেচিত হতে পারে (অর্থাত্ সমস্যাটির যুক্তিসঙ্গত ভাল বিবরণটি গুগলের প্রথম পৃষ্ঠায় উত্তর দেয়)।

এখানে আগ্রহী প্রত্যেকের জন্য হ'ল আমার ডক প্রিও চেকলিস্ট (আমার পক্ষে কাজ করে, আপনার পক্ষে নাও পারে, মন্তব্য এবং পরামর্শগুলি অত্যন্ত প্রশংসা করা হয়):

  1. একটি ব্যক্তিগত লগ / ডায়েরি তৈরি করুন যা আপনি যা কাজ করেছেন / জ্ঞানের ভিত্তিতে যা লিখেছিলেন তা লিখে রাখুন
  2. পরিষেবাগুলি, কোন পরিষেবাটি কোথায়, এটি কী করে এবং এটি কার জন্য করা হয়েছে (কোনও এসএলএ চুক্তি? কোনওটি তৈরি করা উচিত?)
  3. সার্ভারস, কোন সার্ভারটি কোথায়, কত পুরানো এবং কখন এটির লিখিত
  4. উপরের হিসাবে তবে নেটওয়ার্ক সরঞ্জামগুলির জন্য, ইউপিএস এবং এর মতো
  5. উপরের মত তবে সমস্ত ব্যবহারকারীর মেশিনের জন্য
  6. শারীরিক নেটওয়ার্কের বিন্যাস (কোন কেবল কোথায় যায়, এটি কত দিন এবং মাপার মানটি কী)
  7. সার্ভারগুলির জন্য সফ্টওয়্যার এবং লাইসেন্সগুলির কনফিগারেশন ওভারভিউ
  8. ব্যবহারকারী মেশিনগুলির জন্য সফ্টওয়্যার এবং লাইসেন্সগুলির কনফিগারেশন ওভারভিউ
  9. সুইচ, রাউটার এবং অন্যান্য উত্সর্গীকৃত হার্ডওয়্যারগুলির কনফিগারেশন ওভারভিউ
  10. সমস্ত বাহ্যিক দলগুলির চুক্তি এবং এসএলএ, যার জন্য আমার পরিষেবা সরাসরি নির্ভর করে (আইএসপি, ডোমেন ইত্যাদি)
  11. উপরের সমস্ত জিনিস এতে রাখার জন্য সংহত উইকির সাথে একটি টিকিট সিস্টেম সেট আপ করুন।
  12. প্রতিটি ঘটনার জন্য একটি টিকিট তৈরি করুন (এমনকি যদি আপনি এটি কেবল নিজের জন্য ব্যবহার করেন)।
  13. রবিবার একটি স্ক্রিপ্ট তৈরি করুন যা টিকিট সংগ্রহ করে এবং সমস্যার ধরণে তাদের গোষ্ঠী করে।
  14. সোমবার সর্বাধিক দেখা যায় এমন সমস্যার জন্য একটি স্বয়ংক্রিয় সমাধান বা শেষ-ব্যবহারকারী কীভাবে নথি তৈরি করুন
  15. যদি সময় অনুমতি দেয় তবে পরেরটিটি করুন।
  16. যদি আর কিছু না করা হয় তবে একটি নতুন চাকরি সন্ধান করুন এবং যিনি আপনাকে লগ প্রতিস্থাপন করেন তাকে দিন ;-)

1

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

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


ওভাররাইড মূলত বিভাগীয় প্রধানের কাছ থেকে। তবে অন্যরাও তাতে একমত। আমি এখনও আমার বন্দুকের সাথে লেগে আছি এবং দিনের অল্প সময়ের জন্য আমি যতটা পারি তার সাথে যতটা পারি টাইপ করি।
অ্যাভেরি পেইন

1

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

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

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

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.