Làm thế nào để làm tài liệu phần cứng?

Tôi đang xây dựng một số slide cho lớp của mình về cách chúng ta nên ghi lại phần cứng mà chúng ta đang phát triển.

Tôi muốn liệt kê các tài liệu chúng ta nên làm khi xây dựng một số phần cứng. Tôi đã được truyền cảm hứng tại tài liệu phần mềm UML, mang đến nhiều loại tài liệu cho hầu hết mọi tình huống.

Từ kinh nghiệm và nghiên cứu của tôi, rất nhiều dự án chỉ có sơ đồ, bố cục và hóa đơn vật liệu. Tôi nghĩ rằng chúng ta cũng nên thêm thông tin về động cơ (yêu cầu) dẫn chúng ta trong việc lựa chọn một bộ vi điều khiển chứ không phải cái khác. Ngoài ra còn có một số thông tin liên quan đến bố cục mà chúng ta không viết, vì vị trí thành phần đặc biệt không nên thay đổi.

Điều đó đang được nói:

• Làm thế nào chúng ta nên tài liệu phần cứng của chúng tôi?
• Đó là tài liệu quan trọng bạn muốn có nếu bạn cần thực hiện một số cải tiến / thay đổi trên phần cứng của người khác mà bạn chưa từng thấy?
• Làm thế nào để tổ chức những thông tin này một cách rõ ràng?

Tôi hoàn toàn đồng ý với đoạn thứ ba của bạn. Ngoài những điều hiển nhiên như sơ đồ, BOM, v.v ... còn có những điều ít hữu hình hơn như, như bạn nói, tại sao bạn chọn một thành phần cụ thể và cũng quan trọng như vậy, tại sao bạn không chọn một thành phần rõ ràng hơn.

Bây giờ tôi có thể hiển thị tuổi của mình ở đây nhưng tôi vẫn thích sử dụng sổ nhật ký cai trị bìa cứng để ghi lại các quy trình suy nghĩ & quyết định thiết kế của mình - ngay cả những sai. Nếu ai đó trong tương lai cố gắng thay thế một thành phần bằng một 'phù hợp' hơn hoặc di chuyển một bản nhạc trên PCB, các ghi chú của tôi có thể cho họ biết rằng tôi đã ở đó và đốt cháy ngón tay của mình (có lẽ theo nghĩa đen!).

Tôi luôn đánh số trang và cho phép một vài trang ở phía trước dưới dạng mục lục. Bạn cũng có thể ghi lại những thứ như tính toán tiêu tán năng lượng, dung sai, thời gian, v.v. (thói quen này xuất phát từ thời của tôi trong ngành hàng không vũ trụ nơi việc giữ sổ ghi chép là bắt buộc). Tất nhiên bạn luôn có thể đưa thông tin này vào tài liệu WP nhưng tôi sẽ dính vào giấy!

Mô tả mạch cũng có thể phù hợp khi các mạch bất thường (đặc biệt là tương tự) có liên quan. Tôi sẽ coi những điều này giống như các bình luận phần mềm để ghi lại bất kỳ chức năng mạch hoặc thành phần nào. Các sơ đồ, giống như phần mềm nên 'tự ghi lại tài liệu' càng nhiều càng tốt nhưng đôi khi điều này là không đủ.

Một sự thay thế cập nhật hơn, đặc biệt là trong môi trường giáo dục, có thể là có một trang web dự án. Điều này có thể được sắp xếp thành một tập hợp các blog cho từng ngành - thiết kế phần cứng, bố cục pcb, phần mềm, v.v ... Bản chất blog sẽ cho phép những người đóng góp thể hiện dòng suy nghĩ của họ và ghi lại tiến trình của dự án trong khi các trang khác có thể chính thức hơn (tiến trình Biểu đồ Gantt, kết quả kiểm tra, vv). Bạn thậm chí có thể thêm biên bản cuộc họp và danh sách hành động. Các siêu liên kết giúp tham chiếu chéo dễ dàng và bây giờ chúng ta có MathJax, do đó, ngay cả các phương trình thiết kế cũng đơn giản để chèn.

• Làm thế nào chúng ta nên tài liệu phần cứng của chúng tôi?

• Đó là tài liệu quan trọng bạn muốn có nếu bạn cần thực hiện một số cải tiến / thay đổi trên phần cứng của người khác mà bạn chưa từng thấy?

• Làm thế nào để tổ chức những thông tin này một cách rõ ràng?

Trong công ty của chúng tôi, chúng tôi dự kiến ​​sẽ viết tài liệu mô tả thiết kế phần cứng. Đây là những điều khá đơn giản: bạn giải thích ngay từ đầu những gì mạch phải làm, và sau đó đi vào chi tiết trong từng phần. Mọi giá trị thành phần được cho là hợp lý theo một cách nào đó: nếu bạn có điện trở kéo "mặc định" hoặc điện trở nối tiếp, chúng nên được đề cập trong một ghi chú ngay từ đầu (ví dụ: "10K pullups và tụ điện bỏ qua 0,1uF được sử dụng trừ khi có quy định khác") , nếu không các lựa chọn cho các giá trị thành phần cần phải được giải thích. ví dụ: "Bộ lọc RC 4.7K và 0.1uF (tau = 0.47msec) được sử dụng để giới hạn các thành phần tần số cao" hoặc "Bộ ghép kênh NLAS4051 được sử dụng cho rò rỉ thấp - nút mạch này rất nhạy".