ত্রুটি বার্তায় প্রাসঙ্গিক ডকুমেন্টেশনের লিঙ্ক অন্তর্ভুক্ত করবেন?


10

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

বিকাশকারীদের মধ্যে অনেকেই প্রথমবারের ব্যবহারকারী, তাই প্রচুর প্রাথমিক ত্রুটি দেখা দেয়।

ত্রুটি লগতে ডকুমেন্টেশনের লিঙ্কগুলি অন্তর্ভুক্ত করা কি উপযুক্ত? সম্ভাব্য ডাউনসাইডগুলি কী কী? আমি কয়েকটির পূর্বেই ধারণা করতে পারি, তবে নিম্নলিখিতগুলি অতিক্রম করা সম্ভব বলে মনে হচ্ছে

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

আমি কী বোঝাতে চাইছি তার উদাহরণের নীচে, সাহসী পাঠ্য যুক্ত করা কি ভাল ধারণা?

[ত্রুটি] org.apache.maven.plugins: maven-archetype- প্লাগইন: 1.2.3: উত্পাদিত (ডিফল্ট-ক্লিপ) প্রকল্প স্ট্যান্ডেলোন-পম এ কার্যকর করতে ব্যর্থ: কাঙ্ক্ষিত ধনু ধরণের উপস্থিতি নেই (com.example.library)। আরকিটাইপস: লাইব্রেরি-আরচাইটিপ-ফাঁকা: ১.২.৩.০) -> আরও তথ্যের জন্য এবং সম্ভাব্য সমস্যার সমাধানের জন্য দয়া করে http://example.com/docs/setting-up-an-archetype দেখুন


5
ইমো, বর্ণনামূলক ত্রুটিগুলি ভাল এবং যারা প্রস্তাব দিচ্ছে তারা আরও ভাল সহায়তা করে।
সিইস টিমারম্যান

@ সিজটাইমারম্যান আমি সম্পূর্ণরূপে একমত, কিন্তু আমি এই ধরণের বার্তাগুলির মুখোমুখি হই নি। এটি আমাকে এটি করা শুরু করতে দ্বিধাগ্রস্থ করে তোলে, কারণ সম্ভবত এটির জন্য কোনও ভাল কারণ রয়েছে ..
ভন লায়ন

আমি এগুলি 404 পৃষ্ঠাগুলিতে দেখেছি এবং সফ্টওয়্যারে আমি মনে করতে পারি না, সম্ভবত হোমব্রুও।
সিস টিমারম্যান

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

3
@ ভনলিয়ন: অন্য প্রত্যেকে সেগুলি করছিল কারণ জিনিসগুলি করা মধ্যযুগের জন্য একটি রেসিপি।
রবার্ট হার্ভে

উত্তর:


8

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

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

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

হাইপারটেক্সট লিঙ্কগুলি অতিরিক্ত পৃষ্ঠভূমি উপাদান বা সমস্যার ব্যাখ্যা সহ একটি পৃষ্ঠায় একটি সংক্ষিপ্ত ত্রুটি বার্তা সংযোগ করতে ব্যবহার করা যেতে পারে। (যদিও এটি অতিরিক্ত পরিমাণে করবেন না))


এই জন্য আপনাকে ধন্যবাদ! এটি কিছুটা পুরনো হলেও ২০০১ এর আগে আমরা পুরো 'ওয়েব' জিনিসটি সত্যই বুঝতে পেরেছিলাম :-)
ভন লায়ন

3
এটি এখনও ভাল পরামর্শ, তবে সম্ভবত জন কারম্যাকের সাম্প্রতিক এই টুইটটি সহায়তা করে।
সিইস টিমারম্যান

6

হ্যাঁ সর্বাধিক সুস্পষ্টভাবে তবে:

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

আপনি যদি জাভা বা .NET এর সাথে বিকাশ করেন তবে ডকটি একটি জার ফাইল বা একটি ডিএলএল ফাইলের সাথে অন্তর্ভুক্ত করা যেতে পারে এবং উপসর্গ পরিবর্তন করে আপনার কোডটি স্থানীয়ভাবে এর পরিবর্তে আনতে পারে।

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

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

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

আপনার পদ্ধতির পরের বিবর্তন। অনেক বেশি জটিল তবে এর সম্ভাব্য আয় অনেক বেশি। এটি ব্যয়বহুল হবে তবে সঠিক হয়ে গেলে সহজেই তার জন্য মূল্য পরিশোধ করতে হবে।


এই বিস্তৃত উত্তরের জন্য আপনাকে ধন্যবাদ! লিঙ্ক পচা অবশ্যই সমস্যা হবে তবে আশা করি 404-পর্যবেক্ষণে সজাগ থাকা যথেষ্ট হবে; এটি অবশ্যই দেব দলের কাছ থেকে অনেক প্রতিশ্রুতিবদ্ধতা এবং প্রচেষ্টা নেবে (এটি একটি বিদ্যমান কোডবেস ... এটি নতুন হলে পরিচয় করানো সহজ হবে), তবে আপনি যা বলছেন, লাভগুলি এটির পক্ষে উপযুক্ত হতে পারে!
ভন লায়ন


5

অনলাইনের চেয়ে লাইব্রেরির সাথে বান্ডিল করা অফলাইন ডকুমেন্টেশনের দিকে আপনার ইঙ্গিত করা উচিত।

)

(সম্ভবত এটি যদি উইন্ডোজ লাইব্রেরি হয় তবে পথটি আলাদা হবে) be

এখানে সুবিধাগুলি হ'ল:

  • এইভাবে ডকুমেন্টেশন সবসময় লাইব্রেরির সাথে সিঙ্ক হয়। লোকেরা বিকাশ করে এবং পুরানো লাইব্রেরি সংস্করণগুলির সমস্যা সমাধান করে। এবং আপনার সংস্থাটির নাম পরিবর্তন করতে পারে, পণ্যের নাম পরিবর্তন করতে পারে, বা কেউ পুনর্নবীকরণের সময় বলটি ফেলে দিতে পারে example.com

  • ওয়েব দ্রুত পরিবর্তন হয়। আপনি যে লিঙ্কটি দিয়েছেন তা হ'ল httpতবে কয়েক বছরের মধ্যে এর সম্ভাব্য বড় ব্রাউজারগুলি কেবল সমর্থন করবে https। অথবা আমরা সকলেই gopherপ্রোটোকলে ফিরে যেতে পারি ।

  • অ্যাপ্লিকেশন সমস্যা সমাধান সর্বদা ইন্টারনেট অ্যাক্সেস (বা আপনার ডোমেনে অন্তত সরাসরি অ্যাক্সেস) সহ পরিবেশে ঘটে না।

  • আপনি উল্লেখ করেছেন যে আপনার ডকুমেন্টেশন একটি "প্রমাণীকরণ" প্রাচীরের পিছনে রয়েছে। একটি ত্রুটি বার্তা বুঝতে কেবল একটি ওয়েবসাইটে একটি অ্যাকাউন্ট তৈরি করা সুখকর নয় (এজন্য এসও লোকদের লগইন করার প্রয়োজন হয় না)।


3

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

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

হ্যাঁ, আমি এগুলি অনুসন্ধান করতে সক্ষম হতে চাই। ওহ অবশ্যই, আমি জানি যে এটি ঘটেছিল কারণ কিছু নালাগুলি ফেলে রাখা হয়েছিল এবং তারপরে ব্যবহৃত হয়েছিল। সবসময় যা তাত্ক্ষণিকভাবে স্পষ্ট হয় না তা হ'ল কেন কিছু শূন্য ছিল।

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

খুব দয়া করে?


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