Comment faire de la documentation matérielle?

Je construis des diapositives pour ma classe sur la façon dont nous devons documenter le matériel que nous développons.

Je voudrais lister les documents que nous devrions faire lors de la construction de matériel. J'ai été inspiré par la documentation du logiciel UML, qui apporte de nombreux types de documents pour presque toutes les situations.

D'après mon expérience et mes recherches, beaucoup de projets n'ont que les schémas, la mise en page et la nomenclature. Je pense que nous devrions également ajouter des informations sur le motif (les exigences) qui nous conduisent à choisir un microcontrôleur et non l'autre. Il y a aussi quelques informations concernant la disposition que nous n'écrivons tout simplement pas, en tant que position de composant spécial qui ne doit pas être modifiée.

Cela étant dit:

• Comment documenter notre matériel?
• Quels sont les documents importants que vous vouliez avoir si vous avez besoin d'apporter des améliorations / modifications sur du matériel de quelqu'un d'autre que vous n'avez jamais vu?
• Comment organiser ces informations de manière claire?

Je suis entièrement d'accord avec votre troisième paragraphe. Mis à part les éléments évidents comme les schémas, les nomenclatures, etc., il y a les éléments moins tangibles comme, comme vous le dites, pourquoi vous avez choisi un composant particulier et tout aussi important, pourquoi vous n'avez pas choisi un composant peut-être plus évident.

Maintenant, je montre peut-être mon âge ici, mais j'aime toujours utiliser un journal de bord relié pour enregistrer mes processus de pensée et mes décisions de conception - même les mauvaises. Si quelqu'un à l'avenir essaie de remplacer un composant par un composant plus `` approprié '' ou déplace une piste sur le PCB, mes notes pourraient lui dire que j'y suis déjà allé et me suis brûlé les doigts (peut-être littéralement!).

Je numérote toujours les pages et laisse quelques pages à l'avant comme table des matières. Vous pouvez également documenter des éléments tels que les calculs de dissipation de puissance, les tolérances, les horaires, etc. (cette habitude vient de mes jours dans l'industrie aérospatiale où la tenue d'un journal de bord était obligatoire). Bien sûr, vous pouvez toujours mettre ces informations dans un document WP mais je m'en tiendrai au papier!

Des descriptions de circuits peuvent également être appropriées lorsque des circuits inhabituels (en particulier analogiques) sont concernés. Je traiterais ces commentaires comme des logiciels pour documenter toutes les fonctions de circuit ou de composants non évidentes. Les schémas, comme les logiciels, devraient être «auto-documentés» autant que possible, mais parfois cela ne suffit pas.

Une alternative plus à jour, en particulier dans un environnement éducatif, pourrait être d'avoir un site Web de projet. Cela pourrait être organisé comme une collection de blogs pour chaque discipline - conception matérielle, disposition des circuits imprimés, logiciels, etc. Diagrammes de Gantt, résultats des tests, etc.). Vous pouvez même ajouter des minutes de réunion et des listes d'actions. Les hyperliens facilitent les références croisées et nous avons maintenant MathJax, donc même les équations de conception sont simples à insérer.

• Comment documenter notre matériel?

• Quels sont les documents importants que vous vouliez avoir si vous avez besoin d'apporter des améliorations / modifications sur du matériel de quelqu'un d'autre que vous n'avez jamais vu?

• Comment organiser ces informations de manière claire?

Dans notre entreprise, nous sommes censés rédiger des documents de description de conception matérielle. Celles-ci sont assez simples: vous expliquez au début ce que le circuit est censé faire, puis vous entrez dans les détails dans chaque section. Chaque valeur de composant est censée être justifiée d'une certaine manière: si vous avez des résistances de pull-up ou série "par défaut", elles doivent être mentionnées dans une note au début (par exemple, "des pullups de 10K et des condensateurs de dérivation de 0,1 uF sont utilisés sauf indication contraire"). , sinon les choix des valeurs des composants doivent être expliqués. Exemple: "Filtre RC 4.7K et 0.1uF (tau = 0.47msec) utilisé pour limiter les composants haute fréquence" ou "Multiplexeur NLAS4051 utilisé pour une faible fuite - ce nœud de circuit est sensible".