ডকুমেন্টেশন দিয়ে শুরু করা

Question

আমরা আমার কর্মস্থলে কোনও ডকুমেন্টেশন করিনি। আমি এটিতে সম্পূর্ণ নতুন এবং কিছু গাইডেন্স শুরু করার জন্য বলছি ask

আমার কিছু প্রশ্ন আছে:

• সিসাদমিনের প্রয়োজনীয় কাগজপত্রগুলি কী কী রচনা এবং রক্ষণাবেক্ষণ করা উচিত? এবং এগুলি এত গুরুত্বপূর্ণ কেন?

• আপনি কীভাবে আপনার ডকুমেন্টেশনগুলি সিস্টেমের সাথে সিঙ্কে রাখবেন? আপনি কীভাবে তথ্যের সদৃশতা হ্রাস করবেন?

• প্রস্তাবিত গাইড, সেরা অনুশীলন, বিরোধী নিদর্শন?

Comments

সম্পর্কিত: আপনি কিভাবে একটি নেটওয়ার্ক নথি?

— জোড়াদেচি

Answer 1

২০০৩ সাল থেকে আমি আমাদের ইনহাউস উইকিতে সমস্ত কিছু নথিভুক্ত করছি ।

সার্ভার

• হার্ডওয়্যার চশমা
• ওয়ারেন্টি তথ্য
• নেটওয়ার্ক তথ্য
• এবং অবশ্যই ইনস্টল করা সফ্টওয়্যার এবং কনফিগারেশন

কর্মপ্রবাহ

উদাহরণস্বরূপ কীভাবে কোনও ব্যবহারকারী যুক্ত করতে বা মুছতে হয় এবং তাকে সমস্ত প্রাসঙ্গিক পরিষেবাদিতে অ্যাক্সেস দিতে হয়

গুরুত্বপূর্ণ লিঙ্ক

• আপনার সমস্ত ওয়েব ইন্টারফেসের লিঙ্ক
• মনিটরিং ইউআরএলগুলির লিঙ্ক (নাগিওস, মুনিন, এপিসি-মনিটরিং ...)
• উইকিতে লিঙ্ক করুন (মুদ্রিত সংস্করণের জন্য!)

জরুরী নির্দেশাবলী

ইন্ট্রানেট সার্ভার / ইন্টারনেট / ওয়েব সার্ভার / ইত্যাদি ডাউন থাকলে কী করবেন

গুরুত্বপূর্ণ:

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

টুইকি, ডকুমেন্টউইকি বা মিডিয়াউইকি দেখুন।

BTW:

মিডিয়াওয়িকিতে সরাসরি লেখার জন্য একটি ওপেন অফিসিস প্লাগইন রয়েছে - খুব সুবিধাজনক।

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

এটিতে কিছু ইনফো লিখতেও খুব সুন্দর /home/adminuser/maintenance। এটি দ্রুত সম্পন্ন হয় এবং বেশ কয়েকটি সহায়ক হতে পারে, যদি বেশ কয়েকটি প্রশাসক কোনও সার্ভারে কাজ করে। উদাহরণ:

2009-06-27 -thorsten-
          running aptitude update && aptitude full-upgrade
          everything seems ok
2009-06-25 -andreas-
          cups-pdf wasn't reachable. restarted cups
2009-06-23 -thorsten-
          deleted old log under /var/log/squid
etc.

Comments

উইকি ডাউন থাকলে ফ্যালব্যাক ইঙ্গিতটির জন্য +1।

— ম্যানুয়েল ফক্স

ওও কি? ওপেনঅফিসের মতো দেখতে, তবে আমি শেষ "ও" বের করতে পারি না। আপনি যদি প্লাগইনটির নাম রাখতে পারেন তবে এটি দুর্দান্ত।

— ড্যানিয়েল সি। সোব্রাল

ঠিক আছে, ওও ওপেনঅফিস.অর্গ ;-) হ'ল এক্সটেনশন: এক্সটেনশনস.সার্ভিস.ওপেনফাইস.আর

— ডি /

Answer 2

আপনি যখন বুঝতে পেরেছেন যে প্রত্যেকে ডকুমেন্টেশন চায় (এবং প্রয়োজন হয়) তখন আপনাকে এটিও স্বীকৃতি দিতে হবে যে স্টাফটি পড়ার এবং অধ্যয়নের জন্য কারও কাছেই সময় নেই।

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

এটি মাথায় রেখে কিছু পরামর্শ ...

• পাঠ্যের বৃহত ব্লকগুলি এড়িয়ে চলুন
• বুলেট তালিকা আপনার বন্ধু
• একটি পরিষ্কার চিত্রটি সোনালি
• পুনরাবৃত্তি একটি ভাল ধারণা (1)
• এটি আপডেট এবং প্রসারিত করা সহজ করুন

(1) সত্যের একটি উত্স তৈরি করবেন না এবং লোকেরা এটি অনুসন্ধান করতে বাধ্য করবেন না । ধারণাটি যত বেশি গুরুত্বপূর্ণ, ততই আপনার এটি পুনরাবৃত্তি করা উচিত।

Comments

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

— চিহ্নিত করুন

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

— বেভান

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

— টম এইচ

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

— বেভান

আমি পুনরাবৃত্তিটির সাথে দৃhe়ভাবে একমত নই, কারণ একটি আপডেট হবে তবে অন্যরা তা করবে না। অথবা সেগুলি বেমানানভাবে আপডেট করা হবে। পরিবর্তে আরও গুরুত্বপূর্ণ ডক্সকে আরও সহজে লিঙ্ক করা উচিত ।

— gWaldo

Answer 3

প্রয়োজনীয় ডক্স:

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

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

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

Answer 4

আমি খুঁজে পেয়েছি যে টেম্পলেট তৈরি করা একটি বড় সহায়তা is আমার ক্ষেত্রে এটি একটি ওয়ার্ড টেম্পলেট তবে আপনাকে যেটি স্যুট করতে হবে তা ব্যবহার করুন। একটি কঙ্কাল ফাইল তৈরি করুন, সামগ্রীর ক্ষেত্রের সারণি এবং পছন্দসই বিভাগগুলি সহ সম্পূর্ণ করুন। একবার আপনি এটি কয়েকবার ব্যবহার করেছেন, এবং কোনও সুরের সামঞ্জস্য করার পরে, আপনি খুব দ্রুত নতুন ডকুমেন্ট তৈরি করবেন। দস্তাবেজ তৈরি এবং পরে ব্যবহারের জন্য ফর্ম্যাটটির ধারাবাহিকতা একটি দুর্দান্ত সহায়তা হবে। ডকুমেন্টেশন একটি যৌক্তিক জায়গায় এবং একটি লজিকাল ডিরেক্টরি কাঠামো মধ্যে সংরক্ষণ করা প্রয়োজন।

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

আপনার ডকুমেন্টেশন তৈরি করার সময় এটি কী তা মনে রাখবেন। পরবর্তী সময়ে কারও কারও এটি ব্যবহার করা প্রয়োজন। পূর্বের অজান্তে কাজটি করা কি ব্যবহারযোগ্য হবে?

Answer 5

আপনার প্রশ্নের সরাসরি উত্তর নয়, তবে সঠিক দিকের একটি পয়েন্টার:

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

Comments

এই বইয়ের ২ য় সংস্করণে ডকুমেন্টেশন সম্পর্কিত একটি অধ্যায় রয়েছে। "সিস্টেম অ্যাডমিনিস্ট্রেটরদের জন্য টাইম ম্যানেজমেন্ট" সম্পর্কিত একটি বইতে ডকুমেন্টেশন সম্পর্কিত একটি অধ্যায় রয়েছে যা আপনার সংস্থার কী করা উচিত তার চেয়ে আপনার কী করা উচিত তা সম্পর্কে বেশি দৃষ্টি নিবদ্ধ করা হয়েছে।

— টমঅনটাইম

Answer 6

আমার জন্য, সবচেয়ে গুরুত্বপূর্ণ বিবেচনাটি এটি ব্যবহার করা সহজ করে তুলছে। যদি অর্কেস্ট্রেট করতে অসুবিধা হয় তবে লোকেরা এড়াতে পারবেন। আমি এই কারণে আমাদের ডকুমেন্টেশনের মাধ্যম হিসাবে ট্র্যাকের উইকি বেছে নিই :

• কেন্দ্রে অবস্থিত.

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

• সাধারণ সম্পাদনা এবং বিন্যাসকরণ।

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

• নিরীক্ষণের ইতিহাস।

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

Comments

আমি একটি প্রকল্পের ডকুমেন্টেশনের জন্য ট্র্যাকও ব্যবহার করছি। What`s সত্যিই অনুপস্থিত উইকির breadcrump এক ধরনের। আমি আশা করি এটি শীঘ্রই আসবে।

— থারস্টেনস