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


9

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



FWIW আমি এটি সর্বদা করি এবং এমনকি স্ট্যাকএক্সচেঞ্জে এটি কীভাবে সঠিকভাবে করা যায় তা জিজ্ঞাসা করেছি । এটি আপনার প্রশ্নের উত্তর দেয় না, তবে এর পক্ষে এবং বিপক্ষে কিছু যুক্তি সেখানে পাওয়া যাবে।


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

উত্তর:


14

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


3
দুটি কারণের জন্য দরকারী সংক্ষিপ্তসার যুক্ত করা: 1) জিম নির্দেশ করেছেন, এটি লিঙ্কটি পুরানো কিনা তা পাঠককে বুঝতে সহায়তা করে এবং 2) এটি বিকাশকারীকে লিঙ্ক থেকে কোডটি অনুলিপি করছে যাতে তারা কী অনুলিপি করছে তা বুঝতে বাধ্য করে। এটি নিশ্চিত করতে সহায়তা করে যে কোডটি কেবল ব্যবহৃত হচ্ছে না কারণ "এটি সমস্যার সমাধান করে"।
ম্যাজি জাই

7

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

প্রকল্পের উইকিতে আমাদের কী আছে?

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

আমি বিসকলিপি (লিঙ্কগুলি) মিস উইকিতে রেখেছি । তবে কেবলমাত্র আমি বিশ্বাস করি তাদের কাছ থেকে:

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

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

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


1
আমি ডাব্লু 3 স্কুল স্কুল ডটকমকে বিশ্বাস করা বাদ দিয়ে সবকিছুর সাথে একমত। এমডিএন-তে রয়েছে এমন বেশিরভাগটি আপনি খুঁজে পেতে পারেন যার আরও বেশি কর্তৃত্ব রয়েছে।
অল্টারনেটেক্স

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

4

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

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


"ওয়েব্যাক মেশিন - ইন্টারনেট সংরক্ষণাগার" (web.archive.org/) মুছে ফেলা সামগ্রীগুলি পরীক্ষা করার জন্য একটি ভাল জায়গা।
ক্রোমস্টার
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.