हार्डवेयर दस्तावेज़ीकरण कैसे करें?


10

मैं अपनी कक्षा के लिए कुछ स्लाइड्स का निर्माण कर रहा हूं कि हमें उस हार्डवेयर का दस्तावेज कैसे बनाना चाहिए जिसे हम विकसित कर रहे हैं।

कुछ हार्डवेयर बनाते समय हमें उन दस्तावेजों को सूचीबद्ध करना चाहिए, जिन्हें हमें बनाना चाहिए। मैं यूएमएल सॉफ़्टवेयर प्रलेखन से प्रेरित था, जो लगभग हर स्थिति के लिए बहुत सारे दस्तावेज़ प्रकार लाता है।

मेरे अनुभव और अनुसंधान से, बहुत सारी परियोजनाओं में केवल योजनाबद्ध, लेआउट और सामग्री का बिल होता है। मुझे लगता है कि हमें उस मकसद (आवश्यकताओं) के बारे में भी जानकारी जोड़नी चाहिए जो हमें एक माइक्रोकंट्रोलर चुनने में मदद करता है और दूसरा नहीं। लेआउट के संबंध में कुछ जानकारी भी है जिसे हम केवल विशेष घटक स्थिति के रूप में नहीं लिखते हैं, जिसे बदला नहीं जाना चाहिए।

बताया जा रहा है:

  • हमें अपने हार्डवेयर का दस्तावेज कैसे बनाना चाहिए?
  • यदि आपके द्वारा देखे गए किसी और हार्डवेयर पर आपको कुछ सुधार / परिवर्तन करने की आवश्यकता है, तो आप कौन से महत्वपूर्ण दस्तावेज चाहते थे?
  • इन सूचनाओं को स्पष्ट तरीके से कैसे व्यवस्थित करें?

1
मुझे लगता है कि डिलिवरेबल्स के बारे में इस सवाल के बारे में बहुत सलाह है कि हार्डवेयर से संबंधित डिजाइन प्रोजेक्ट के परिणामों को पूरी तरह से सौंपने के लिए क्या दिया जाना चाहिए।
कोर्तुक

तस्वीरें !!!! अच्छी तरह से उपयोग किए जाने पर सूचना सामग्री और सूचना घनत्व की विशाल मात्रा।
रसेल मैकमोहन

धन्यवाद कोर्तुक। इस तरह की जानकारी मैं देख रहा था, लेकिन मुझे अभी भी लगता है कि हमें इस बारे में अधिक जानकारी चाहिए कि परियोजना का विकास कैसे हुआ और इंजीनियर ने कुछ निर्णय क्यों लिए।
RMAAlmeida

जवाबों:


3

मैं आपके तीसरे पैराग्राफ से दृढ़ता से सहमत हूं। योजनाबद्ध चीजों, बीओएम आदि जैसी स्पष्ट चीजों के अलावा, कम मूर्त चीजें हैं जैसे कि आप कहते हैं, आपने एक विशेष घटक क्यों चुना और महत्वपूर्ण के रूप में, आपने एक और अधिक स्पष्ट घटक क्यों नहीं चुना।

अब मैं अपनी उम्र यहाँ दिखा रहा हो सकता है, लेकिन मैं अभी भी अपनी विचार प्रक्रियाओं और डिजाइन निर्णयों को रिकॉर्ड करने के लिए एक हार्डबैक शासित लॉग बुक का उपयोग करना पसंद करता हूं - यहां तक ​​कि गलत भी। यदि भविष्य में कोई व्यक्ति एक घटक को अधिक 'उपयुक्त' के साथ बदलने की कोशिश करता है या पीसीबी पर नज़र रखता है, तो मेरे नोट्स उन्हें बता सकते हैं कि मैं पहले ही वहां जा चुका हूं और मेरी उंगलियों को जला दिया है (शायद सचमुच!)।

मैं हमेशा पृष्ठों की संख्या और सामग्री के एक तालिका के रूप में सामने कुछ पृष्ठों की अनुमति देता हूं। आप इस तरह की चीजों को शक्ति अपव्यय, सहिष्णुता, समय आदि की गणना के रूप में भी दस्तावेज कर सकते हैं (यह आदत एयरोस्पेस उद्योग में मेरे दिनों से आती है जहां लॉग बुक रखना अनिवार्य था)। बेशक आप इस जानकारी को हमेशा WP दस्तावेज़ में रख सकते हैं, लेकिन मैं कागज पर चिपका रहूँगा!

सर्किट विवरण भी उपयुक्त हो सकते हैं जहां असामान्य (विशेषकर एनालॉग) सर्किट चिंतित हैं। मैं किसी भी स्पष्ट सर्किट या घटक कार्यों का दस्तावेजीकरण करने के लिए सॉफ्टवेयर टिप्पणियों की तरह इनका इलाज करूंगा। जहाँ तक संभव हो स्कैमैटिक्स, सॉफ़्टवेयर की तरह 'स्व-दस्तावेजीकरण' होना चाहिए, लेकिन कभी-कभी यह पर्याप्त नहीं होता है।

एक विशेष रूप से शैक्षिक वातावरण में एक अप-टू-डेट विकल्प, एक परियोजना वेबसाइट हो सकती है। इसे प्रत्येक अनुशासन के लिए ब्लॉगों के संग्रह के रूप में व्यवस्थित किया जा सकता है - हार्डवेयर डिज़ाइन, पीसीबी लेआउट, सॉफ़्टवेयर आदि। ब्लॉग प्रकृति योगदानकर्ताओं को अपने विचार प्रवाह को दिखाने और परियोजना की चल रही प्रगति का दस्तावेजीकरण करने की अनुमति देगी, जबकि अन्य पृष्ठ अधिक औपचारिक हो सकते हैं (प्रगति गैंट चार्ट, परीक्षा परिणाम आदि)। आप मीटिंग मिनट और एक्शन लिस्ट भी जोड़ सकते हैं। हाइपरलिंक्स क्रॉस-रेफ़रिंग को आसान बनाते हैं और अब हमारे पास MathJax है इसलिए डिज़ाइन समीकरण भी सम्मिलित करने के लिए सरल हैं।


ब्लॉग के संग्रह की तुलना में इस उद्देश्य के लिए कहीं बेहतर ऑनलाइन उपकरण हैं। काम पर, हम (~ 500 इंजीनियर) अपने विकी, बग ट्रैकिंग और संस्करण नियंत्रण उपकरण के लिए Redmine परियोजना प्रबंधन का उपयोग करते हैं , लेकिन कई विकल्प हैं । स्कूल में, हम Google साइटें और डॉक्स का उपयोग करते हैं।
केविन वर्मर

@ केविन वर्मियर - अंतिम पैराग्राफ को बाद में जोड़ा गया था - मैं पहले रेडमाइन में नहीं आया था, लेकिन यह इस उद्देश्य के लिए बहुत अच्छा लग रहा है कि यह मूल परियोजना प्रबंधन से परे जाने के लिए लगता है। बहुत सारे उपकरण एक या दो क्षेत्रों में महान हैं और दूसरों में कमी है।
माइकज-यूके 20

डिजाइन से संबंधित किसी भी परियोजना के लिए, एक प्रयोगशाला नोटबुक को बनाए रखा जाना चाहिए, जिसमें लिखित नोट्स होते हैं, इस बात पर प्रकाश डाला जाता है कि विकल्प क्यों बनाए गए, योजनाबद्ध तरीके से टेप किए गए, समय-समय पर गवाह के हस्ताक्षर .... इस प्रकार के सामान बौद्धिक संपदा वकीलों को खुश रखते हैं, और दस्तावेजों की तरह भी होते हैं ओपी के लिए सामान के बारे में बात कर रहा है
स्कॉट Seidman

2
  • हमें अपने हार्डवेयर का दस्तावेज कैसे बनाना चाहिए?

  • यदि आपके द्वारा देखे गए किसी और हार्डवेयर पर आपको कुछ सुधार / परिवर्तन करने की आवश्यकता है, तो आप कौन से महत्वपूर्ण दस्तावेज चाहते थे?

  • इन सूचनाओं को स्पष्ट तरीके से कैसे व्यवस्थित करें?

हमारी कंपनी में हमें हार्डवेयर डिज़ाइन विवरण दस्तावेज़ लिखने की उम्मीद है। ये बहुत सीधे हैं: आप शुरुआत में बताते हैं कि सर्किट को क्या करना है, और फिर प्रत्येक अनुभाग में विस्तार से जाना। प्रत्येक घटक मूल्य को किसी तरह से उचित माना जाता है: यदि आपके पास "डिफ़ॉल्ट" पुलअप या श्रृंखला प्रतिरोधक हैं, तो उन्हें शुरुआत में एक नोट में उल्लेख किया जाना चाहिए (उदाहरण के लिए "10K पुलअप और 0.1uF बाईपास कैपेसिटर का उपयोग तब तक किया जाता है जब तक कि अन्यथा निर्दिष्ट न हो)" , अन्यथा घटक मूल्यों के लिए विकल्पों की व्याख्या करने की आवश्यकता है। जैसे "4.7K और 0.1uF RC फ़िल्टर (ताऊ = 0.47msec) उच्च आवृत्ति घटकों को सीमित करने के लिए उपयोग किया जाता है" या "NLAS4051 मल्टीप्लेक्स कम रिसाव के लिए उपयोग किया जाता है - यह सर्किट नोड संवेदनशील है"।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.