ทำเอกสารฮาร์ดแวร์อย่างไร

10

ฉันกำลังสร้างสไลด์สำหรับชั้นเรียนของฉันเกี่ยวกับวิธีที่เราควรจัดทำเอกสารฮาร์ดแวร์ที่เรากำลังพัฒนา

ฉันต้องการแสดงรายการเอกสารที่เราควรทำเมื่อสร้างฮาร์ดแวร์ ฉันได้รับแรงบันดาลใจจากเอกสารซอฟต์แวร์ UML ซึ่งนำเอกสารหลายประเภทมาใช้ได้เกือบทุกสถานการณ์

จากประสบการณ์และการวิจัยของฉันมีหลายโครงการเท่านั้นที่มีแผนงานโครงร่างและรายการวัสดุ ฉันคิดว่าเราควรเพิ่มข้อมูลเกี่ยวกับแรงจูงใจ (ข้อกำหนด) ที่นำเราไปสู่การเลือกไมโครคอนโทรลเลอร์หนึ่งตัวไม่ใช่อื่น ๆ นอกจากนี้ยังมีข้อมูลบางอย่างเกี่ยวกับเลย์เอาต์ที่เราเพิ่งไม่เขียนเนื่องจากตำแหน่งองค์ประกอบพิเศษที่ไม่ควรเปลี่ยนแปลง

ที่ถูกบอกว่า:

เราควรจัดทำเอกสารฮาร์ดแวร์ของเราอย่างไร
เอกสารสำคัญชิ้นใดที่คุณต้องการถ้าคุณต้องการทำการปรับปรุง / แก้ไขบางอย่างบนฮาร์ดแวร์ของคนอื่นที่คุณไม่เคยเห็นมาก่อน?
จัดระเบียบข้อมูลเหล่านี้อย่างชัดเจนอย่างไร

documentation

— RMAAlmeida
แหล่งที่มา

1

ฉันคิดว่าคำถามเกี่ยวกับสิ่งที่ส่งมอบนี้มีคำแนะนำที่ดีเกี่ยวกับสิ่งที่จะต้องมอบให้กับผลลัพธ์ของโครงการออกแบบฮาร์ดแวร์ที่เกี่ยวข้องอย่างสมบูรณ์

— Kortuk

ภาพถ่าย !!!! ปริมาณข้อมูลและความหนาแน่นของข้อมูลที่กว้างใหญ่หากใช้งานได้ดี

— รัสเซลแม็คมาฮอน

ขอบคุณ Kortuk นั่นคือข้อมูลประเภทที่ฉันกำลังมองหา แต่ฉันยังคงคิดว่าเราต้องการข้อมูลเพิ่มเติมเกี่ยวกับวิธีการพัฒนาโครงการและทำไมวิศวกรจึงตัดสินใจบางอย่าง

— RMAAlmeida

3

ฉันเห็นด้วยอย่างยิ่งกับย่อหน้าที่สามของคุณ นอกเหนือจากสิ่งที่ชัดเจนเช่นแผนงาน, BOM ฯลฯ ก็มีสิ่งที่จับต้องได้น้อยกว่าอย่างที่คุณพูดว่าทำไมคุณถึงเลือกองค์ประกอบเฉพาะและที่สำคัญทำไมคุณไม่เลือกองค์ประกอบที่ชัดเจนกว่านี้

ตอนนี้ฉันอาจแสดงอายุของฉันที่นี่ แต่ฉันยังต้องการใช้สมุดบันทึกที่มีการปกครองแบบปกแข็งเพื่อบันทึกกระบวนการคิดและการออกแบบการตัดสินใจของฉัน - แม้แต่สิ่งที่ผิด หากใครบางคนในอนาคตพยายามที่จะเปลี่ยนชิ้นส่วนด้วย 'ที่เหมาะสม' มากกว่าหรือย้ายแทร็กบน PCB โน้ตของฉันอาจบอกพวกเขาว่าฉันเคยไปที่นั่นมาแล้วและเผานิ้วของฉัน

ฉันมักจะนับจำนวนหน้าและอนุญาตให้หน้าไม่กี่หน้าเป็นสารบัญ นอกจากนี้คุณยังสามารถบันทึกสิ่งต่าง ๆ เช่นการคำนวณการกระจายพลังงานความอดทนกำหนดเวลา ฯลฯ (นิสัยนี้มาจากยุคสมัยของฉันในอุตสาหกรรมการบินและอวกาศซึ่งต้องเก็บสมุดบันทึกไว้) แน่นอนคุณสามารถใส่ข้อมูลนี้ลงในเอกสาร WP ได้เสมอ แต่ฉันจะยึดติดกับกระดาษ!

คำอธิบายวงจรอาจเหมาะสมเมื่อมีวงจรที่ผิดปกติ (โดยเฉพาะอะนาล็อก) ฉันจะปฏิบัติต่อสิ่งเหล่านี้เช่นความคิดเห็นของซอฟต์แวร์เพื่อบันทึกฟังก์ชั่นวงจรหรือส่วนประกอบใด ๆ Schematics เช่นซอฟต์แวร์ควร 'จัดทำเอกสารด้วยตนเอง' ให้ไกลที่สุด แต่บางครั้งก็ไม่เพียงพอ

ทางเลือกที่ทันสมัยมากขึ้นโดยเฉพาะในสภาพแวดล้อมทางการศึกษาอาจมีเว็บไซต์โครงการ สิ่งนี้สามารถจัดเป็นชุดของบล็อกสำหรับแต่ละระเบียบวินัย - การออกแบบฮาร์ดแวร์เค้าโครง pcb ซอฟต์แวร์ ฯลฯ ลักษณะของบล็อกจะช่วยให้ผู้มีส่วนร่วมแสดงความคิดและเอกสารความคืบหน้าอย่างต่อเนื่องของโครงการในขณะที่หน้าอื่น ๆ อาจเป็นทางการมากขึ้น แผนภูมิแกนต์ผลการทดสอบ ฯลฯ ) คุณสามารถเพิ่มนาทีการประชุมและรายการการกระทำ การเชื่อมโยงหลายมิติทำให้การอ้างอิงโยงเป็นเรื่องง่ายและตอนนี้เรามี MathJax ดังนั้นแม้แต่การออกแบบสมการก็ง่ายที่จะแทรก

— MikeJ สหราชอาณาจักร
แหล่งที่มา

มีเครื่องมือออนไลน์ที่ดีกว่าสำหรับวัตถุประสงค์นี้มากกว่าชุดของบล็อก ที่ทำงานเรา (~ 500 วิศวกร) ใช้Redmineจัดการโครงการสำหรับวิกิพีเดียของการติดตามปัญหาและเครื่องมือในการควบคุมรุ่น แต่มีหลายทางเลือก ที่โรงเรียนเราใช้ Google Sites และ Docs

— Kevin Vermeer

@Kevin Vermeer - ย่อหน้าสุดท้ายถูกเพิ่มเข้ามาภายหลัง - ฉันไม่เคยเจอ Redmine มาก่อน แต่มันก็ดูดีสำหรับจุดประสงค์นี้เพราะดูเหมือนว่ามันจะไปไกลกว่าการจัดการโครงการพื้นฐาน เครื่องมือจำนวนมากยอดเยี่ยมในหนึ่งหรือสองด้านและขาดในส่วนอื่น ๆ

— MikeJ-UK

สำหรับโครงการใด ๆ ที่เกี่ยวข้องกับการออกแบบสมุดบันทึกห้องปฏิบัติการควรได้รับการดูแลรักษาประกอบด้วยบันทึกเป็นลายลักษณ์อักษรเน้นว่าทำไมมีการเลือกบันทึกเทปในแผนงานลายเซ็นพยานเป็นระยะ ... สิ่งต่าง ๆ เหล่านี้ทำให้ทนายความทรัพย์สินทางปัญญามีความสุข สิ่งที่ OP กำลังพูดถึง

— Scott Seidman

2

เราควรจัดทำเอกสารฮาร์ดแวร์ของเราอย่างไร

เอกสารสำคัญชิ้นใดที่คุณต้องการถ้าคุณต้องการทำการปรับปรุง / แก้ไขบางอย่างบนฮาร์ดแวร์ของคนอื่นที่คุณไม่เคยเห็นมาก่อน?

จัดระเบียบข้อมูลเหล่านี้อย่างชัดเจนอย่างไร

ใน บริษัท ของเราเราคาดว่าจะเขียนเอกสารคำอธิบายการออกแบบฮาร์ดแวร์ สิ่งเหล่านี้ค่อนข้างตรงไปตรงมา: คุณอธิบายในตอนแรกว่าควรทำอย่างไรวงจรและจากนั้นไปลงรายละเอียดในแต่ละส่วน ค่าองค์ประกอบทุกตัวควรได้รับการพิสูจน์ด้วยวิธีการบางอย่าง: หากคุณมีตัวต้านทานแบบ "เริ่มต้น" หรือตัวต้านทานแบบอนุกรมพวกเขาควรจะกล่าวถึงในหมายเหตุในตอนเริ่มต้น (เช่น "10K pullups และตัวเก็บประจุบายพาส 0.1uF มิฉะนั้นจะต้องอธิบายตัวเลือกสำหรับค่าส่วนประกอบ เช่น "4.7K และ 0.1uF RC filter (tau = 0.47msec) ใช้เพื่อ จำกัด ส่วนประกอบความถี่สูง" หรือ "NLAS4051 multiplexer ใช้สำหรับการรั่วไหลต่ำ - โหนดวงจรนี้มีความสำคัญ"

— เจสันเอส
แหล่งที่มา