Comment documentez-vous vos décisions de conception de matériel?


43

Comment documentez-vous vos décisions en matière de matériel en phase de conception? Comment éviter de devoir vous poser les questions suivantes lors de la révision d'une conception matérielle que vous avez faite dans le passé:

  • Pourquoi avoir choisi ce composant?
  • Pourquoi / comment ai-je choisi ces paramètres particuliers pour ce composant?
  • Que fait cette partie du circuit?
  • Quelle est la dissipation de puissance à travers ce composant?
  • Quelle est la consommation totale de ce circuit?
  • Puis-je remplacer ce composant par cet autre? Existe-t-il des composants équivalents à ce composant? etc.

Quel est un bon moyen de documenter vos décisions et vos calculs pendant la phase de conception d’un circuit? Comment puis-je obtenir des réponses aux questions ci-dessus sans parcourir à nouveau des centaines de pages de fiche technique?

Une solution à laquelle je pourrais penser est d’ajouter des notes dans les fichiers de schéma (si votre EDA le supporte), mais je ne voudrais pas encombrer le schéma de trop d’informations.


1
Qui va voir ces détails? Sont-ils juste pour votre référence ou seront-ils vus par d'autres?
stanri

@Stacey La documentation est destinée à la fois à moi et aux autres concepteurs. J'aimerais que la plupart de mes futures conceptions soient open source et il est très important qu'elles soient correctement documentées.
m.Alin

9
@ Stacey Mais vraiment .. quelle est la différence? Au bout d'un moment, vous examinerez votre propre design comme si c'était la première fois que vous le voyez ..
m.Alin

2
La différence réside dans la manière dont l'information est présentée. Un document officiel expliquant chaque décision que vous avez prise avec un ton professionnel demandera beaucoup plus de travail que de noter rapidement des formules et des notes sur les valeurs que vous avez choisies. De plus, si quelqu'un d'autre voit les notes, le fait qu'elles soient numériques est important.
stanri

4
OMG j'adore cette question. (désolé, je sais que cela n’aide pas vraiment, mais c’est un projet sur lequel je travaille actuellement, c’est formidable). Continuer.
efox29

Réponses:


15

Personnellement, je vais à l’ancienne voie: j’ai un cahier de conception où j’écris absolument tout ce qui concerne les décisions de conception que je prends. Particulièrement les choix de composants et de valeurs, les calculs actuels, les calculs d'alimentation, tout. Je documente également les décisions relatives aux logiciels / micrologiciels et les notes sur le calendrier et l'utilisation des ressources.

Chaque bloc-notes a une page de contenu pour référencer une partie spécifique de la conception (alimentation, etc.) et toutes les pages sont numérotées.

J'ai envisagé de passer au numérique plusieurs fois, mais il est agréable d'avoir mon cahier devant moi pendant que je travaille et je trouve que écrire des formules numériquement est assez délicat. Il est beaucoup plus facile d'écrire des calculs à la main.

Lors de la préparation d'une spécification ou d'une documentation formelle pour la conception d'un tableau, je me réfère généralement à mon cahier comme un rappel de ce que j'ai fait (ou j'écris la documentation numérique en même temps). Même si cela peut sembler faire deux fois la même chose, je constate que mes cahiers ne sont quasiment que des calculs et des explications pour moi-même, où la documentation est beaucoup moins verbeuse et beaucoup plus formelle et explicative pour les autres. En tant que tel, je ne trouve pas souvent que j'écris deux fois la même chose.


Je suis tout à fait d’accord sur le problème des formules, mais j’ai arrêté d’utiliser des notes en papier il ya environ 5 ans. La frappe est beaucoup plus facile que l' écriture, et a tous les avantages de textes électroniques habituels - des recherches, expédiable, backupable, etc.
markt

2
Certains des cahiers de conception les plus impressionnants / importants de notre époque: computerhistory.org/collections/fairchild . Un des avantages importants d'un journal de bord / cahier est le dessin. Il faut beaucoup plus d'efforts pour dessiner / dessiner des éléments sur mon ordinateur portable (bien que ce soit plus facile avec un iPad - ma femme, par exemple, conserve ses notes de conception sur son ipad). J'ai tendance à penser graphiquement alors je fais beaucoup de ma conception en dessinant des diagrammes.
Slebetman

11

Vous pouvez revenir en arrière et mettre à jour les spécifications de conception avec ces informations. Ou bien prenez la spécification et créez une spécification de niveau inférieur où vous décrivez plus en détail ce que vous allez faire et pourquoi, idéalement avant de commencer les schémas :). Puis mettez à jour au fur et à mesure et archivez avec les schémas.


Répondez aux questions ci-dessous: Eh bien, ce que nous faisons habituellement, c’est d’abord des exigences en matière de marketing, puis une réponse technique officielle ou une discussion informelle. Ceci est suivi par un MRD (document des exigences marketing), en format Word, utilisant notre modèle. Cela inclut les exigences, l’analyse de la concurrence, la taille du marché, les opportunités, les coûts de développement estimés, etc. C’est généralement écrit par une personne du marketing (ou une personne au-dessus de ma classe salariale).

Vient ensuite le PRD (document relatif aux exigences du produit) rédigé généralement par l’ingénierie, également dans un modèle Word. Ceci décrit plus en détail de manière technique ce que le produit va faire, quelles pièces sont nécessaires et comment chacune d’elles fonctionnera. Nous inclurons souvent ici les performances cibles, le prix, la puissance, la taille et d’autres mesures.

Suit des spécifications fonctionnelles détaillées pour chacune des sections. Certains travaux de conception sont en réalité effectués ici bien avant d’être intégrés au schéma. Par exemple, la puissance sera calculée, les pièces sélectionnées et de nombreuses recherches effectuées. C'est l'endroit où nous documenterions toutes les décisions de conception non évidentes.

Pour finir, nous aborderons les schémas, ce qui est la partie la plus facile à ce stade car une grande partie du travail de conception a été effectué au stade de la spécification. Là où cela devrait être fait à mon avis :) Si quelque chose change pendant la phase schématique, par exemple, nous pensons que quelque chose ne fonctionnera pas ou si une personne en marketing se précipite dans le couloir en disant qu'elle doit être rouge au lieu de bleu, nous le ferons. reviendra et mettra à jour les spécifications.

Toutes les spécifications, PRD, MRD sont conservées dans le SVN avec des liens vers les documents sur un wiki interne. Une modification des spécifications entraînera une mise à jour de SVN et une notification aux parties intéressées. Vous pouvez bien sûr simplement le conserver manuellement dans un dossier partagé quelque part.

C'est plus ou moins mon processus, je pense que vous voudrez peut-être documenter chaque petite décision prise à propos d'un dessin et nous ne le faisons certainement pas. Ne pas dire que vous ne devriez pas, je pourrais voir où ce serait utile. Je suppose que nous documentons habituellement le comment et pas le pourquoi tout le temps.


Ok, j'aurais peut-être dû aussi aborder chaque question :)

Si vous faites des calculs, dans Excel peut-être? Ou sur papier et si vous pensez que les résultats et la méthode sont importants pour la compréhension et la conception de votre circuit, vous devez les inclure dans la section appropriée de la spécification de conception. Même si cela signifie prendre une photo de votre dessin à la main :)

Pourquoi avoir choisi ce composant? Je pense que la spécification fonctionnelle est un bon endroit pour cela, pas besoin de devenir fou, mais juste une simple ou deux lignes sur ses avantages. Je réserverais ceci aux composants critiques. Je ne pense pas que vous souhaitiez expliquer pourquoi vous avez choisi une résistance de rappel, par exemple.

Pourquoi / comment ai-je choisi ces paramètres particuliers pour ce composant? Combinez cela avec ce qui précède.

Que fait cette partie du circuit? Cela ferait partie de vos spécifications fonctionnelles, si le circuit est suffisamment important pour justifier cette question, il devrait avoir sa propre section.

Quelle est la dissipation de puissance à travers ce composant? Si vous parlez d’alimentation, mettez ceci dans la section d’alimentation, j’aime aussi le noter sur les schémas. Bien que toutes mes pièces proviennent d'une base de données et que le schéma y soit directement lié, nous pouvons facilement voir les paramètres, la feuille de données, etc.

Quelle est la consommation totale de ce circuit? Je pense que cela appartient à la section alimentation de votre spécification.

Puis-je remplacer ce composant par cet autre? Existe-t-il des composants équivalents à ce composant? etc. Je pense que cela appartient à votre nomenclature ou à tout processus que vous utilisez pour la fabrication. Les pièces de rechange doivent faciliter l’approvisionnement. Encore une fois pour nous, tout cela provient d'une base de données de pièces.


Je me suis rendu compte que je devais documenter ma conception (d'où la question), mais je ne connais pas de bonne méthode pour le faire. Est-ce que j’écris mes notes dans un fichier texte, est-ce que je les mets directement dans le schéma, est-ce que j’écris les notes sur papier, puis je les numérise? Comment garder les notes de décision de conception synchronisées avec la conception et que doivent réellement contenir les notes? Quelle est la méthode de documentation qui fonctionne pour vous?
m.Alin

1
@ m.Alin SHG semble fonctionner comme moi, et a un document de spécifications qui est fait avant de travailler sur un schéma. Ce document doit contenir des exigences détaillées pour le circuit, des informations sur l'ensemble du système, le raisonnement derrière les décisions majeures, etc. Ce document documente votre processus de réflexion et répertorie les exigences que vous pouvez ensuite prendre pour concevoir votre schéma. C’est la voie à suivre dans un cadre professionnel, mais vous pouvez vous en sortir avec des cahiers, par exemple, si vous faites la conception à la maison. J'ai l'habitude de garder un dossier sur mon serveur de travail avec
I. Wolfe

1
Sorti de la pièce ... -avec le document de spécification, toute documentation de test, tous les schémas fonctionnels du système dans son ensemble, les fiches techniques des pièces critiques, etc. Tout cela dans un sous-dossier (le dossier planning / spécifications) du dossier de projet. Dans un dossier séparé, j'aurais le schéma, la disposition de la carte et toute la documentation d'assemblage / de fabrication pertinente. Idéalement, vous aimeriez que quelqu'un puisse obtenir toutes les informations dont il a besoin d'un document, mais parfois, il n'est pas difficile de se passer d'une feuille de données ou d'informations / de tests détaillés.
I. Wolfe

ajouté des commentaires sur notre processus inline
Some Hardware Guy

4
+1 pour utiliser le contrôle de version pour les documents critiques. Tout le monde devrait l'utiliser, même un seul ingénieur indépendant.
Lior Bilia

5

Je fais beaucoup de conception à rotation rapide et je dois dire que: annoter le schéma est de loin la chose la plus pratique. Il est rare que l'une de mes conceptions ait plus de 2 ou 3 feuilles A4. Le nombre de décisions de conception est donc limité. Beaucoup de décisions de conception sont quasiment automatiques; Je n'ai pas besoin d'énumérer les raisons pour chaque partie. Juste une ou deux parties principales et peut-être un filtre ou un dimensionnement passif. Le reste est immédiatement évident pour tout ingénieur concepteur expérimenté.

En ce qui concerne votre dernière question: les pièces de rechange ne sont généralement pas une décision de conception, mais une décision d’achat, et en tant que telle, elles font partie de votre flux de travail d’approvisionnement. Dans mon cas, les pièces alternatives se trouvent dans les propriétés de ma pièce et sont automatiquement recherchées si le stock de la pièce principale ou de la source est épuisé.

Pour les conceptions plus grandes et pour la conception de système, j’ai tendance à utiliser Google Docs avec un modèle de document de conception.

En résumé; Personnellement, j’estime qu’un flux de travail compact sera rentable à la fin. Le fait de disposer de nombreux fichiers séparés avec des informations de conception (conception de système distincte, documents de décision de conception, documents d’approvisionnement, tous séparés de vos fichiers de schémas et d’agencement de base) engendre beaucoup de confusion (mentale) et nécessite une commutation de contexte à chaque fois que vous souhaitez revoir une conception. décision. Tout avoir au même endroit fonctionne bien. Si votre schéma commence à sembler encombré, ce flux de travail n’est pas un problème, mais signifie plutôt que vous devriez probablement compartimenter mieux votre conception, utiliser plus de feuilles ou utiliser des feuilles plus grandes.


3
Il est généralement préférable d’avoir un document de spécification, au moins dans un cadre professionnel. Par exemple, si je veux savoir pourquoi j'ai choisi une valeur de fusible, il serait bon de savoir que ma sortie consomme 700mA pour 50uS, puis 300mA pour 3s. Ces informations encombrent simplement un schéma où tout ce que vous avez besoin de mettre est le calibre du fusible, mais pourrait être nécessaire à un moment donné. Il y a aussi des circonstances dans lesquelles six servos ont été exécutés par un même régulateur et j'ai besoin de savoir combien de moteurs fonctionneront simultanément. Encore une fois quelque chose de nécessaire, mais pas sur le schéma.
I. Wolfe

1
Bien sûr, les opinions varieront. Tout ce que je dis, c'est qu'avec plus de 200 créations à mon actif, je trouve que cela fonctionne vraiment bien. «Professionnel» ne signifie pas forcément protocole et méthodologie stricts. pour les conceptions relativement petites (ce qui est la majorité de ce que je fais), cela fonctionne bien. Des conceptions plus grandes et particulièrement collaboratives (ce qui est très rare de nos jours, même des éléments tels que Raspberry Pi est conçu et présenté par le même homme) nécessitent toutefois un peu plus de rigueur.
user36129

4

Pour beaucoup de mes plus petits projets, j'ai généralement placé une simple étiquette verte et une bordure autour des sous-circuits. Pour les projets plus importants, certains logiciels eCAD vous permettent de construire à partir d'un diagramme, où chaque feuille décrit plus en détail un seul bloc. Il est un art de décomposer n'importe quel problème et de gérer les compromis (c'est l'ingénierie à mon humble avis). Lorsque le choix des composants, comme le filtrage analogique, est clairement analysé, je noterai la fréquence de coupure et le type de filtre (par exemple, filtre passe-bas (f_c = 100Hz)).

Les blocs communs que je rencontre à maintes reprises incluent:

  • Gestion de l'alimentation (régulateurs de tension, protection contre l'inversion de polarité, diodes TVS, interrupteur d'alimentation, bouchons de dérivation, etc.)
  • MCU (microcontrôleur, en-tête ou pads de programmation, capuchons de contournement de puce)
  • Indicateurs (p. Ex. DEL, câble électroluminescent, afficheur à 7 segments, moteur vibrant)
  • Détection d'une caractéristique particulière (p. Ex. Détection de courant, détection tactile, RSG, activité, détection environnementale, etc.)
  • Débogage des communications (perle de ferrite, USB, I2C, UART, SPI, moyen d’obtenir des informations)
  • Radio (tous les composants de support pour plusieurs radios)
  • Vidéo (tous les composants de support et les puces pour une caméra)
  • Stockage externe (par ex. Flash externe, puce EEPROM pour stocker les paramètres, etc.)
  • Toute autre caractéristique unique à votre conception

Avec ces sous-blocs clairement organisés et étiquetés, je peux utiliser un schéma en moins de quelques minutes.


3

Je tiens un cahier de conception et documente soigneusement les besoins / désirs. Pour les premiers prototypes, je vais faire une sélection de pièces, en prenant note de toutes les vraies décisions. Pour les modifications ultérieures, j'utilise un processus FMEA assez formel, documentant le besoin non satisfait afin de justifier un changement - car, de toute évidence, s'il n'y a pas de besoin non satisfait, il n'est pas nécessaire de changer!

Si je suis assez rigoureux à ce sujet, je peux suivre chaque modification de conception (matériel, logiciel, mécanique) en fonction des besoins.

Toutes les versions de toutes les choses sont suivies en utilisant subversion.

Il peut s’agir d’un élément essentiel d’un fichier d’historique de conception, indispensable pour la FDA.


3

J'ai souvent utilisé keynote (vous pouvez également choisir d'utiliser PowerPoint). Cela présente l’avantage d’autoriser les captures d’écran de logiciels de simulation tels que les interfaces graphiques SPICE et autres.

Pour moi, la clé est la possibilité de copier des extraits de code dans des feuilles de données et de les annoter afin que les importances relatives dans mes décisions de conception apparaissent. Je peux également inclure des photos de cartes de circuits imprimés ou de planches à modeler anciennes, ainsi que des liens vers des articles que j'avais l'habitude de choisir.

Je trouve aussi que j'ai tendance à vouloir faire des maths et des dessins en utilisant un crayon sur du papier. Je prends donc une photo avec mon téléphone et la dépose dans le keynote sans retaper. Parfois, pour de courtes équations, je peux utiliser LaTeX et laisser tomber cela.

Je peux aussi inclure des parcelles dessinées par des logiciels scientifiques tels que Octave.

De nos jours, en particulier pour les tâches de calcul intensif, je peux choisir de faire une partie de ce travail dans les cahiers IPython, mais je ne l’ai pas spécifiquement fait pour la conception de circuits, uniquement pour le calcul physique.

Enfin, les Keynotes / Powerpoints sont faciles à reproduire et à exporter sous forme de fichier PDF à distribuer à des non-spécialistes.


3

Placez des notes d'ingénierie sur les schémas et, si nécessaire, créez plus de feuilles. Je place toujours des notes d'ingénierie sur tous mes schémas car, dans mon monde, il se peut que je doive visiter à nouveau des demi-dessins cuits au four pendant un certain temps, puis les replacer à l'arrière-plan pendant que j'en récupère un autre; débit de conception très fluide. Ces notes sur l'EE m'aident, ainsi que d'autres, à réintégrer l'intention de conception avec peu d'effort. J'utilise également différentes couleurs de texte / graphiques pour indiquer l'importance ou le contexte. Exemple ci-dessous ...entrez la description de l'image ici

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.