ডকুমেন্টেশনের চেয়ে উদাহরণ পছন্দ করুন। এটা কি আচরণগত সমস্যা?


23

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

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

আমি প্রোগ্রামার হিসাবে এই খারাপ অভ্যাসটি কীভাবে ভাঙ্গবো বা আমি অতিরিক্ত বিবেচনা করছি?


3
আমি এটি একটি খারাপ অভ্যাস বলে মনে করি না। আমি সর্বদা উদাহরণগুলি দিয়ে শুরু করি এবং তারপরে প্রয়োজনীয় ডকুমেন্টেশন পড়ি।
কাপ্তান

1
a million times better than examples as the official documentation has more coverage- সর্বদা নয়, উদাহরণের মাধ্যমে আমি অতীতে বেশ কিছু অননুমোদিত বৈশিষ্ট্য পেয়েছি
ইজকাটা

ডকুমেন্টেশনের উদাহরণগুলির সাথে ধারণাগুলি যোগাযোগ করা উচিত। আমি সাধারণত দস্তাবেজগুলিতে বিবেচনা করি যা নথিতে ব্যর্থতা হিসাবে না
এসভিডজেন

উত্তর:


30

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

উদাহরণ:

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

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

আপনি স্টক পরিমাণ পরিমাণ রিফ্রেশ করতে পরিষেবা জোর করতে পারেন। এটি refresh-quantitiesএকটিকে সেট করে করা হয়।

বিস্তারিত, তবে বিরক্তিকর এবং সবে পঠনযোগ্য। আপনার লিঙ্কগুলি অনুসরণ করা দরকার তা বিষয়গুলিকে আরও খারাপ করে তোলে। আমরা যদি কিছু নমুনা সংযোজন করি তবে এটি বোঝা আরও সহজ হয়ে যায়:

GET পণ্য / সূচক /
জিইটি পণ্য / সূচক / 12345 /
জিইটি পণ্য / সূচক /? এড়ান = 100 & নিন = 20
GET পণ্য / সূচক /? বিভাগ = 12
জিইটি পণ্য / সূচক /? মূল্য = 0..39.90
জিইটি পণ্য / সূচক /? বিভাগ = 12 & লাফালাফি = 100 & নেওয়া = 20

আপনি কেবল উদাহরণগুলি ব্যবহার করেন এমন সমস্যাটি হতে পারে। উদাহরণস্বরূপ উদাহরণগুলি ব্যবহার বন্ধ করবেন না, তবে মনে রাখবেন আপনি একবার ধারণাটি পেয়ে গেলে আরও একটি ভার্বোজ ডকুমেন্টেশন সহায়তা করতে পারে। উদাহরণস্বরূপ, উপরের নমুনাটি দেখায় না যে পণ্যগুলির তালিকা 1 000 এর মধ্যে সীমাবদ্ধ: আপনার জন্য ডকুমেন্টেশন পড়তে হবে।

আপনি কখন জানেন যে আপনার ডকুমেন্টেশনটি পড়া উচিত?

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

GET পণ্য / সূচক /? এড়ান = 6000 এবং নিন = 3000

কোনও কারণে এটি 3000 এরও কম আইটেম ফেরত দেয়, যখন আপনার ডাটাবেসে বিশ হাজারেরও বেশি পণ্য রয়েছে। এখানে, এপিআই আপনার প্রত্যাশার মতো আচরণ করছে না , তাই বিস্তারিত ডকুমেন্টেশন পড়ার জন্য এটি ভাল সময়।


নিখুঁত জ্ঞান তোলে। উদাহরণ দিয়ে পথ প্রশস্ত করা হলেও সর্বদা ডকুমেন্টেশনে ফিরে আসুন!
ব্যবহারকারী 6123723

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

10

ডকুমেন্টেশন দ্বারা সরবরাহিত তথ্যগুলি তিনটি ক্যাটজরিতে পড়ে:

  • রেসিপি।
  • রেফারেন্স।
  • বিশেষজ্ঞ জ্ঞান.

রেসিপি বা উদাহরণ সমস্যা ডোমেন এবং সফ্টওয়্যার এর কার্যকারিতা মধ্যে একটি সেতু তোলে। রেফারেন্স সম্পূর্ণরূপে কিছু কার্যকারিতা বর্ণনা করে এবং আপনি যদি কোনও নির্দিষ্ট ক্ষেত্রে কোনও রেসিপি মানিয়ে নিতে চান তবে তা কার্যকর।

(ডকুমেন্টেশন ধারণার কাছে বিশেষজ্ঞ জ্ঞানের মানচিত্রের ধারণাগুলির ধারণাগুলি, যদি ধারণাগুলি একাধিক আচরণে প্রকাশ করা যায় বা সফ্টওয়্যারটির ব্যবহারকারীরা ক্ষেত্রের বিশেষজ্ঞ না হন তবে এটি কার্যকর))

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

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


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

2

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


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

1

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

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