Come creare la documentazione hardware?

10

Sto creando alcune diapositive per la mia classe su come dovremmo documentare l'hardware che stiamo sviluppando.

Vorrei elencare i documenti che dovremmo fare quando costruiamo dell'hardware. Sono stato ispirato dalla documentazione del software UML, che porta molti tipi di documenti per quasi ogni situazione.

Dalla mia esperienza e ricerca, molti progetti hanno solo gli schemi, il layout e la distinta materiali. Penso che dovremmo anche aggiungere informazioni sul motivo (requisiti) che ci portano a scegliere un microcontroller e non l'altro. Ci sono anche alcune informazioni riguardanti il layout che non scriviamo, come posizione del componente speciale che non dovrebbe essere modificata.

Detto questo:

Come dovremmo documentare il nostro hardware?
Quali sono i documenti importanti che volevi avere se avessi bisogno di apportare miglioramenti / alterazioni su hardware di qualcun altro che non hai mai visto?
Come organizzare queste informazioni in modo chiaro?

documentation

— RMAAlmeida
fonte

1

Penso che questa domanda sui risultati finali offra ottimi consigli su ciò che deve essere dato per consegnare completamente i risultati di un progetto di progettazione relativo all'hardware.

— Kortuk,

Fotografie !!!! Vasta quantità di contenuto e densità di informazioni se usato bene.

— Russell McMahon

Grazie Kortuk. Questo è il tipo di informazioni che stavo cercando, ma penso ancora che abbiamo bisogno di ulteriori informazioni su come è stato sviluppato il progetto e perché l'ingegnere ha preso alcune decisioni.

— RMAAlmeida

3

Sono pienamente d'accordo con il tuo terzo paragrafo. A parte le cose ovvie come schemi, DBA ecc. Ci sono cose meno tangibili come, come dici tu, perché hai scelto un componente particolare e altrettanto importante, perché non hai scelto un componente forse più ovvio.

Ora potrei mostrare la mia età qui, ma mi piace ancora usare un diario di bordo con copertina rigida per registrare i miei processi di pensiero e decisioni di progettazione - anche quelli sbagliati. Se qualcuno in futuro tenta di sostituire un componente con uno più "adatto" o sposta una traccia sul PCB, i miei appunti potrebbero dire loro che sono già stato lì e mi sono bruciato le dita (forse letteralmente!).

Numero sempre le pagine e consento alcune pagine in primo piano come sommario. Puoi anche documentare cose come i calcoli della dissipazione di potenza, le tolleranze, i tempi ecc. (Questa abitudine viene dai miei giorni nel settore aerospaziale dove era obbligatorio tenere un diario di bordo). Ovviamente potresti sempre mettere queste informazioni in un documento WP ma mi atterrò sulla carta!

Le descrizioni dei circuiti potrebbero anche essere appropriate quando si tratta di circuiti insoliti (soprattutto analogici). Tratterei questi commenti come software per documentare qualsiasi circuito non visibile o funzioni dei componenti. Gli schemi, come il software, dovrebbero essere "auto-documentanti" per quanto possibile, ma a volte questo non è abbastanza.

Un'alternativa più aggiornata, specialmente in un ambiente educativo, potrebbe essere quella di avere un sito web del progetto. Questo potrebbe essere organizzato come una raccolta di blog per ogni disciplina - progettazione hardware, layout del pcb, software ecc. La natura del blog consentirebbe ai partecipanti di mostrare il loro flusso di pensiero e documentare i progressi in corso del progetto mentre altre pagine potrebbero essere più formali (progresso Diagrammi di Gantt, risultati dei test ecc.). È anche possibile aggiungere verbali delle riunioni ed elenchi di azioni. I collegamenti ipertestuali semplificano i riferimenti incrociati e ora abbiamo MathJax, quindi anche le equazioni di progettazione sono semplici da inserire.

— MikeJ-UK
fonte

Ci sono strumenti online di gran lunga migliori a questo scopo di una raccolta di blog. Al lavoro, noi (~ 500 ingegneri) utilizziamo la gestione dei progetti Redmine per i suoi strumenti wiki, di tracciamento dei bug e di controllo della versione, ma ci sono molte alternative . A scuola, utilizziamo Google Sites e Documenti.

— Kevin Vermeer

@Kevin Vermeer - L'ultimo paragrafo è stato aggiunto come ripensamento - Non mi sono mai imbattuto in Redmine prima, ma è perfetto per questo scopo in quanto sembra andare ben oltre la gestione di base del progetto. Molti strumenti sono fantastici in una o due aree e carenti in altre.

— MikeJ-UK

Per qualsiasi progetto che coinvolga il design, un quaderno di laboratorio dovrebbe essere mantenuto, contenente note scritte, evidenziando il motivo per cui le scelte sono state fatte, registrate negli schemi, le firme dei testimoni periodici .... Questo tipo di cose rende felici gli avvocati della proprietà intellettuale e documenta anche il tipo di roba di cui parla OP

— Scott Seidman,

2

Come dovremmo documentare il nostro hardware?

Quali sono i documenti importanti che volevi avere se avessi bisogno di apportare miglioramenti / alterazioni su hardware di qualcun altro che non hai mai visto?

Come organizzare queste informazioni in modo chiaro?

Nella nostra azienda siamo tenuti a scrivere documenti di descrizione del progetto hardware. Questi sono piuttosto semplici: spieghi all'inizio cosa dovrebbe fare il circuito, e poi vai nei dettagli in ogni sezione. Si suppone che ogni valore del componente sia giustificato in qualche modo: se si dispone di pullup "predefiniti" o resistori in serie, dovrebbero essere menzionati all'inizio in una nota (ad esempio "vengono utilizzati pullup 10K e condensatori di bypass 0.1uF se non diversamente specificato") , altrimenti devono essere spiegate le scelte per i valori dei componenti. ad es. "Filtro RC 4.7K e 0.1uF (tau = 0.47msec) utilizzato per limitare i componenti ad alta frequenza" o "Multiplatore NLAS4051 utilizzato per basse perdite - questo nodo di circuito è sensibile".

— Jason S
fonte