আমি অন্য কারও অতীতের কাজটি কীভাবে দলিল করব? [বন্ধ]


9

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

বর্তমান ডকুমেন্টেশনগুলি সাধারণত এই জাতীয় কিছু পড়ে:

চালানের আগে এই প্রোগ্রামটি চালানো হয়। জ্ঞাত বাগ: কিছুই নেই।

এক্স সফটওয়্যার ইনস্টল করার পরে এই প্রোগ্রামটি চালান

এই প্রতিবেদনে নিম্নলিখিত ক্ষেত্রগুলি পরিবর্তন করা হয়েছে: (কীভাবে বা কেন তার কোনও ব্যাখ্যা ছাড়াই)

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

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

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

আমি কীভাবে এই জিনিসটি নিজের এবং অন্যদের জন্য সক্রিয়ভাবে নথিভুক্ত করতে পারি?

উত্তর:


14

আমি মনে করি এটি একটি নিরর্থক অনুশীলন। এটি যদি কাজ করে তবে এটি কাজ করে, যদি এটি কাজ না করে তবে আপনাকে এটি ঠিক করতে হবে।

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

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


2
হ্যাঁ, এটি বয় স্কাউট নিয়মের জন্য অন্য একটি , তবে আমি আরও যুক্ত করব - আপনার উত্স ভান্ডারে ডকুমেন্ট, কোনও উইকে নয়। আপনার ডকুমেন্টেশনটি আপনার উত্স কোডের নিকটবর্তী (উদাহরণস্বরূপ ভিজ্যুয়াল স্টুডিওতে জাভাডক বা এক্সএমএল দ্বারা) এটি আপ টু ডেট রাখার সম্ভাবনা তত বেশি, আপনার কোডের সাথে এটি সংস্করণিত হয়। আমি শুধু একজন না আপনার মতো rstএবং sphinxজন্য কোডে লেখা ডকুমেন্টেশন ঘনিষ্ঠ পালন
মার্ক বুথ

9

পরিবর্তনগুলি দলিল করার জন্য আপনার প্রচেষ্টা ত্যাগ করুন ।

পরিবর্তে, বর্তমানে কী কাজ করে এবং কীভাবে ডকুমেন্ট করা শুরু করুন । আপনি ভবিষ্যতে পরিবর্তনগুলি করার সাথে সাথে সেই ডকুমেন্টেশনটি আপ টু ডেট এবং বর্তমান রাখুন।


8

আপনার কি সোর্স নিয়ন্ত্রণ আছে?

যা থেকে পরিবর্তন হয়েছে আপনি কি কাজ করতে পারেন?

যদি তা হয় তবে আপনি নতুন বৈশিষ্ট্য বা বাগ ফিক্স কিনা তা ব্যবসায়ের পরিবর্তনে মানচিত্র তৈরি করতে সক্ষম হতে পারেন।

কোনও পুরানো বিকাশকারীদের মেলবক্সকে পুনরুত্থিত করা কি সম্ভব? (এটি গোপনীয়তা সংক্রান্ত উদ্বেগের সাথে কার্যকর কিনা তা নিশ্চিত নয়)। সেখান দিয়ে ট্রলিং করে প্রচুর তথ্য লাভ করতে পারে।


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

5

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

এটি কয়েকটি গুরুত্বপূর্ণ বৈশিষ্ট্য সরবরাহ করে:

  • দস্তাবেজগুলি কোম্পানির ল্যানে যেকোন জায়গায় অ্যাক্সেস করা যায় (নতুন কম্পিউটারে ইনস্টল করা ...)
  • সমস্ত দস্তাবেজ এক জায়গায়
  • সমস্ত দস্তাবেজ অনুসন্ধানযোগ্য
  • আপনি সহযোগিতা করতে পারেন (নতুন সহকর্মী, সফ্টওয়্যার ব্যবহারকারী)

এখন, যদি আপনার ডকুমেন্টেশনগুলি কাগজ আকারে থাকে তবে আমি আপনাকে শুভকামনা জানাচ্ছি। আপনার যদি ওয়ার্ড ডক্স থাকে তবে একটি আমদানি স্ক্রিপ্ট তৈরি করুন

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

আরও সুনির্দিষ্ট ডকুমেন্টেশনের দিকে এগিয়ে যাওয়া, যদি আপনাকে বিভিন্ন প্রকল্পের উত্সের সাথে কাজ করার প্রয়োজন হয় তবে নিশ্চিত করুন যে আপনার একটি উপযুক্ত বিকাশ পরিবেশ রয়েছে ! স্টাফের চেকলিস্টের জন্য আপনার থাকা উচিত:

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

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

সম্পাদনা:

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


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

+1, দুর্দান্ত তথ্য, আপনি কি আমাকে ডোকুইকি সম্পর্কে বলতে পারেন?
প্রেসলেডিয়াস

লিঙ্কে কি আছে? বৈশিষ্ট্য তালিকা পরীক্ষা করুন । আমাদের সেটআপটি আর্টিক টেম্পলেট ব্যবহার করে তাই উইকি একটি মিনি সিএমএস হিসাবে কাজ করে। আপনি যদি কোনও ডেবিয়ান সিস্টেমে থাকেন তবে অ্যাপটি-গেট ব্যবহার না করে ম্যানুয়ালি ইনস্টল করুন ! দেবিয়ান অ-মানক অবস্থান ব্যবহার করে যা এটি পরিচালনা করার জন্য একটি ব্যথা করে।
স্পেন্সার রথবুন

2

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

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

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

শুভকামনা!


দুর্ভাগ্যক্রমে এটি কোনও traditionalতিহ্যবাহী প্রোগ্রামিং সেটআপ নয় ... বেশিরভাগ প্রতিবেদন এবং জিইউআই প্রোগ্রামের কীভাবে কাজ করে তা পরিবর্তনের জন্য কিছু অদ্ভুত, মালিকানাধীন ভাষার ফাইল ব্যবহার করে changes
বেন ব্রোকা

2

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

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


1

আপনি স্বয়ংক্রিয় অনুসন্ধানের পরীক্ষা লিখতে পারেন। এর বিভিন্ন সুবিধা রয়েছে:

  • আপনার লেখার সাথে সাথে সিস্টেমটি কীভাবে কাজ করে তা আপনি শিখেন

  • তারা পরবর্তীকালে সম্পাদনযোগ্য ডকুমেন্টেশন হিসাবে পরিবেশন করে

  • আপনি যদি এগুলিকে নিয়মিত বা এমনকি ধারাবাহিক ভিত্তিতে চালনা করেন তবে পরিবর্তনগুলি কখন কিছু ভেঙে দেয় বা তাদের আপডেট করার দরকার হয় তা সনাক্ত করার জন্য তারা একটি দুর্দান্ত সুরক্ষা জাল সরবরাহ করে

আপনার নির্দিষ্ট পরিবেশে যদিও এই ধরণের পরীক্ষাগুলি লিখতে পারা সম্ভব কিনা তা আমি জানি না।

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