কিভাবে হার্ডওয়ার ডকুমেন্টেশন করবেন?


10

আমি আমাদের ক্লাসের জন্য কয়েকটি স্লাইড তৈরি করছি যা আমাদের বিকাশ করা হার্ডওয়্যারটি কীভাবে ডকুমেন্ট করা উচিত।

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

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

যা বলা হচ্ছে:

  • আমাদের হার্ডওয়্যারটি কীভাবে ডকুমেন্ট করা উচিত?
  • আপনি যে হার্ডওয়ারটি কখনও দেখেননি সে সম্পর্কে আপনার যদি কিছু উন্নতি / পরিবর্তন প্রয়োজন হয় তবে আপনি যে গুরুত্বপূর্ণ ডকুমেন্টটি পেতে চেয়েছিলেন?
  • কীভাবে এই তথ্যগুলি একটি সুস্পষ্ট উপায়ে সংগঠিত করবেন?

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

ফটো !!!! যদি ব্যবহার করা হয় তবে প্রচুর পরিমাণে তথ্য সামগ্রী এবং তথ্য ঘনত্ব।
রাসেল ম্যাকমাহন

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

উত্তর:


3

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

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

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

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

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


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

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

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

2
  • আমাদের হার্ডওয়্যারটি কীভাবে ডকুমেন্ট করা উচিত?

  • আপনি যে হার্ডওয়ারটি কখনও দেখেননি সে সম্পর্কে আপনার যদি কিছু উন্নতি / পরিবর্তন প্রয়োজন হয় তবে আপনি যে গুরুত্বপূর্ণ ডকুমেন্টটি পেতে চেয়েছিলেন?

  • কীভাবে এই তথ্যগুলি একটি সুস্পষ্ট উপায়ে সংগঠিত করবেন?

আমাদের সংস্থায় আমরা হার্ডওয়্যার ডিজাইনের বিবরণ ডকুমেন্ট লিখব বলে আশা করা হচ্ছে। এগুলি বেশ সহজবোধ্য: আপনি সার্কিটের কী করণীয় তা শুরুতে ব্যাখ্যা করুন এবং তারপরে প্রতিটি বিভাগে বিশদে যান into প্রতিটি উপাদান মান কোনও উপায়ে ন্যায়সঙ্গত বলে মনে করা হয়: আপনার যদি "ডিফল্ট" পুলআপ বা সিরিজ প্রতিরোধক থাকে তবে সেগুলি শুরুতে একটি নোটে উল্লেখ করা উচিত (উদাহরণস্বরূপ "10K পুলআপস এবং 0.1uF বাইপাস ক্যাপাসিটারগুলি অন্যথায় নির্দিষ্ট না করা পর্যন্ত ব্যবহৃত হবে") অন্যথায় উপাদান মানগুলির জন্য পছন্দগুলি ব্যাখ্যা করা দরকার। যেমন "উচ্চ ফ্রিকোয়েন্সি উপাদানগুলিকে সীমাবদ্ধ করতে ব্যবহৃত" 4.7K এবং 0.1uF আরসি ফিল্টার (টাউ = 0.47msec) "বা" নিম্ন ফুটোয়ের জন্য ব্যবহৃত এনএলএএস 4051 মাল্টিপ্লেক্সার - এই সার্কিট নোড সংবেদনশীল "।

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