Donanım belgeleri nasıl yapılır?

Sınıfım için geliştirdiğimiz donanımı nasıl belgelendirmemiz gerektiği konusunda bazı slaytlar hazırlıyorum.

Bazı donanımlar oluştururken yapmamız gereken belgeleri listelemek istiyorum. Neredeyse her durum için birçok belge türü getiren UML yazılım belgelerinden ilham aldım.

Deneyimlerim ve araştırmamdan, birçok projede sadece şemalar, düzen ve malzeme listesi var. Ayrıca bizi bir mikroişlemciyi değil diğerini seçmemize götüren sebep (gereksinimler) hakkında bilgi eklememiz gerektiğini düşünüyorum. Değiştirilmemesi gereken özel bileşen konumu olarak, sadece yazmadığımız düzen ile ilgili bazı bilgiler de vardır.

Bu söyleniyor:

• Donanımımızı nasıl belgelemeliyiz?
• Daha önce hiç görmediğiniz başka bir donanımda bazı iyileştirmeler / değişiklikler yapmanız gerekirse, sahip olmak istediğiniz önemli belge hangileridir?
• Bu bilgileri nasıl net bir şekilde düzenleyebilirim?

Üçüncü paragrafınıza kesinlikle katılıyorum. Belirli bir bileşeni ve sadece neden önemli olduğunu neden seçtiklerini, dediğiniz gibi dışında bariz şeylerden şemaları gibi, vb ürün ağaçları, daha az somut şeyler gibi orada yoktu bir belki daha belirgin bileşeni seçin.

Şimdi yaşımı burada gösteriyor olabilirim ama hala düşünce süreçlerimi ve tasarım kararlarımı kaydetmek için ciltli kurallı bir kayıt defteri kullanmak istiyorum - yanlış olanları bile. Gelecekte bir kişi bir bileşeni daha 'uygun' bir bileşenle değiştirmeye çalışırsa veya PCB'de bir parça taşırsa, notlarım onlara zaten orada olduğumu ve parmaklarımı yaktığımı söyleyebilir (belki de kelimenin tam anlamıyla!).

Her zaman sayfaları numaralandırıyorum ve içindekiler tablosu olarak birkaç sayfaya izin veriyorum. Ayrıca, güç kaybı, toleranslar, zamanlamalar vb. Hesaplamaları da belgeleyebilirsiniz (bu alışkanlık havacılık endüstrisinde günlüğümden bir defter tutmanın zorunlu olduğu günlerden gelir). Tabii ki bu bilgiyi her zaman bir WP belgesine koyabilirsiniz, ancak kağıda yapışacağım!

Devre açıklamaları, olağandışı (özellikle analog) devreler söz konusu olduğunda da uygun olabilir. Açık olmayan devre veya bileşen işlevlerini belgelemek için bu yazılım yorumları gibi davranırdım. Şemalar, yazılım gibi olabildiğince 'kendi kendini belgeleme' olmalıdır, ancak bazen bu yeterli değildir.

Özellikle eğitim ortamında daha güncel bir alternatif, bir proje web sitesine sahip olmak olabilir. Bu, her disiplin için bir blog koleksiyonu olarak düzenlenebilir - donanım tasarımı, pcb düzeni, yazılım vb. Blog doğası, katkıda bulunanların düşünce akışlarını göstermesine ve diğer sayfalar daha resmi olabilirken (ilerleme) projenin devam eden ilerlemesini belgelemesine izin verir. Gantt şemaları, test sonuçları vb.). Toplantı tutanakları ve eylem listeleri bile ekleyebilirsiniz. Köprüler çapraz referansı kolaylaştırır ve şimdi MathJax'a sahibiz, bu nedenle tasarım denklemlerinin bile eklenmesi basittir.

• Donanımımızı nasıl belgelemeliyiz?

• Daha önce hiç görmediğiniz başka bir donanımda bazı iyileştirmeler / değişiklikler yapmanız gerekirse, sahip olmak istediğiniz önemli belge hangileridir?

• Bu bilgileri nasıl net bir şekilde düzenleyebilirim?

Şirketimizde donanım tasarımı açıklama belgeleri yazmamız beklenmektedir. Bunlar oldukça basittir: başlangıçta devrenin ne yapması gerektiğini açıklarsınız ve sonra her bölümde ayrıntılara girersiniz. Her bileşen değerinin bir şekilde gerekçelendirilmesi gerekir: "varsayılan" çekme veya seri dirençleriniz varsa, bunlar başlangıçta bir notta belirtilmelidir (örneğin, aksi belirtilmedikçe "10K çekme ve 0,1 uF baypas kapasitörleri kullanılır") aksi halde bileşen değerleri için seçimlerin açıklanması gerekir. örneğin "yüksek frekanslı bileşenleri sınırlamak için kullanılan 4.7K ve 0.1uF RC filtre (tau = 0.47msec)" veya "düşük sızıntı için kullanılan NLAS4051 çoklayıcı - bu devre düğümü hassastır".