Tvorba technickej dokumentácie

[MrWifiHifi]

Zdravím

Pri práci nielen s elektronikou je vždy potrebná nejaká dokumentácia, či už v podobe manuálu, schémy alebo návodu na intetnete. Aj pri testovaní a zapájaní rôznych obvodov je dobré si značiť, zakresľovať a zapisovať svoj postup.

Moja otázka je, ako postupujete pri vytváraní dokumentácie? Čo by ste odporučili a čo naopak neodporučili? Ako s niečim takýmto vôbec začať a ako sa dopracovať až dokonca?

[technikus110]

Začať s rozumom a do konca sa dopracovať trpezlivosťou.....

Ale vážne. Dokumentácia pre výrobu (výrobný postup), alebo pre koncového užívateľa sú dva rôzne pojmy s rôznymi pravidlami a výsledkom. Takže s rozumom upresniť si smerovanie záznamu.

[MrWifiHifi]

Ak som ešte niečo takéto vôbec nikdy nepísal .... ako s niečim takýmto začať? da sa pri písaní podľa niečoho riadiť ako napr. podľa nejakej osnovy?

[rudko]

technicka dokumentacia? vyrobny postup? navod na pouzivanie? coz toho chces pisat?

[MrWifiHifi]

Chcel by som vedieť opísať napríklad testovanie zapojenia, návrh nejákého obvodu (postup pri návrhu, možno nejaké výpočty) ale aj výrobu niečoho (napr. DPS, krabičky, alebo hocičo iné)

[pajky]

Asi to zalezi od umu /tvojho/. Popisat dolezite veci. Detejly su dolezite, ale pisat detajl pajkovania v nejakom pokrocilom projekte je blud.
Kedze budes pisat o projekte ktory robis ty, tak popis bude vhodny asi o veciach ktore zaujali, potrapili teba.

[StefanST]

Záleží od cieľovej skupiny pre ktorú je dokumentácia určená:
Koncový používateľ (návod na použitie), potenciálny kupec zariadenia, pracovník servisu pre zariadenie, výrobca zariadenia, montážnik zariadenia, potenciálny výrobca zariadenia (komu to ponúkaš), maturitná komisia, atď. atď. Každého zaujíma niečo iné a nechce sa prehrabávať množstvom, pre neho irelevantnej, dokumentácie.

[pin]

Keď som kedysi nastúpil do Tesly, vyfasoval som hrubú písanku A4 v tvrdých doskách, tzv. denník konštruktéra. Tam sa zapisovali návrhy obvodov, výpočty, merania a pod. Nebola to dokumentácia, ale malo to svoj význam, všetko mal človek pokope. Teraz to býva roztrúsené po fajloch v PC.

[MrWifiHifi]

No myslel som aj na niečo take....vlastne, vždy ak si, napr. ja, chcem zapojiť a otestovať nejaké zapojenie, bolo by dobre si k tomuto písať poznámky, postrehy čo a ako zapájať alebo cčmu sa vyvarovať... Zaujímavé by to možno bolo urobiť, nejak tak, ako spomenul pin, formou denníka alebo zápisníka

[rudko]

mno ked si chces pisat poznamky pre seba tak musis sam vediet ako si to potrebujes zapisat tak aby si za 5 rokov chapal co si napisal

[MrWifiHifi]

Veď práve o to ide

[Jerry19]

Z toho co opisujes to vyzera tak, ze by ta mohol zaujimat aj checklist...

napr...

Questions
ReUse of standardized or already produced circuit parts considered
CAD schematic is present in readable form (also as hardcopy)
Schematic tested regarding electrical interconnection / Netlist (schematic review)
Schematic reviewed in regarding part references
Schematic reviewed regarding component polarity
Schematic reviewed regarding connectors interfaces / connectror numbering / correct placement and signal order
Schematic reviewed regarding labeling / marking of circuit parts
Schematic reviewed regarding labeling / marking of galvanical isolation
Is the circuit designed enough low resistant, so that the condensation of the printed board (especially OU) as possible does not lead to malfunction?
Schematic reviewed regarding external circuitry (actuators, sensors, displays, etc.)
Are no external switches and inputs connected to internal multiplexing applications for LEDs or switches (e.g. display multiplexer, on-board buttons, sensors, ...)?
/EMC / power ground concept (power and ground connections, star points, block / smoothing-capacitors, filters)
Schematic reviewed regarding cabeling within the appliace (eg. ext. Line filter, wire connections)
Schematic reviewed regarding the connection of electromechanical components (heat sinks, metal shielding,etc.)
It is guaranteed that the reverse voltage produced by switching off inductances (Valves, Pump) is limited by adequate protective circuits on the electronics or on the component? Particularly critical when the switching is done by relays.
schematic reviewed regarding approbation relevant requirements (including labeling)
Signal tables created for eg. special ICs like microcontrollers (Pin list)


To je len prvych niekolko otazok zkopirovanych z nasho firemneho Circuit checklistu... Na niektore otazky sa samozrejme vyplni aj odpoved NR (not relevant)... Otazka sa tyka napr. rele, ale nasa elektronika ziadne rele nema... Alebo displeja..

Cely checklist ma 220 otazok..Sem tam sa nejaka opakuje
Podobny mame aj layout checklist...

Potom sa robi "error list" a to je zjednodusene povedane to, ze kazda suciastka v scheme resp. kazdy jej pin sa prerusi, alebo vyskratuje s kazdym susednym, teda sa zaradom skratuju suciastky po jednej, vzdy len jedna, resp. sa zdvihaju nozicky... a vysledok sa zapise do dokumentu... Pokial nastane situacia, ze jedna porucha typu skrat alebo prerusenie sposobi velky problem tak sa to musi riesit... Elektronika musi byt vsade kde sa da odolna voci tomu, ze nastane jedna takato chyba, resp. nesmie to sposobovat, ze prestanu fungovat nejake veci dolezite pre bezpecnost, niekde je jeden skrat alebo niekde je jedno prerusenie... Samozrejme niektore situacie a sceneria ktore su jasne sa neskusaju a sa len vyplni ze co sa stane... Skrat napr medzi + a - za usmernovacom, piny na usmernovaci atp... Procesor ked vojde do resetu v hocijakom case a stave elektroniky, nesmie nastat neziaduci stav... HW watchdogy sa kontroluju a blokovanie atd... A pokial ta elektronika podlieha nejakej aprobacii napr UL alebo VDE atd, tak od nich pridu tak ci tak taketo poziadavky, resp. namietky... ze napr. ak nastane porucha tranzistora T2 stane sa toto a toto a to sa nesmie stat len preto, ze sa vyskratoval jeden tranzistor...

No a v praxi je dost caste, ze samotna elektronika teda HW ale aj software je omnoho komplikovanejsia ako je nutne len preto aby boli splnene rozne bezpecnostne poziadavky, su tam naviac rozne blokovania HW watchdogy, software kontroluje stale dokola milion veci a procak je zahlteny mnozstvom taskov aby v pripade ze nieco je mimo normalnych hodnot hend zareagoval...

Napr. Ked chcem procesorom ovladat nejake rele ktore je safety relevant, musim mat zabezpecene, ze minimalne pri starte zariadenia prebehne kontorla rele na zlepene kontakty... Dalej nemozem ovladat rele (safety relevant) len tak, ze nastavim na pine jednotku a rele zopne... Musim to robit tak, ze rele zopne len ked na pine je signal s frekvenciou v nejakom rozsahu (je tam teda HW blokovanie)... Aby sa zabezpecilo, ze ked zamrzne software a ostane tam jednotka na pine rele neostane visiet zopnute...

No lenze toto su vsetko take veci, ktore su relevantne ked sa vyvija elektronika do nejakeho domaceho spotrebica napr. Ktory musi splnat mnozstvo veci aby sa mohol uviest normalne na trh... V poslednej dobe je napr. velke halo okolo toho, ze spotrebice uz musia mat stand-by spotrebu pod 0,3W. Ale zaroven bybolo dobre aby mal spotrebic WiFi, IoT aby sa dal zobudit a ovladat cez wifi atd...

Ale checklist obsahuje aj plno otazok ktore si tam sami vyvojari popridavali lebo usudili, ze je to dolezite...
Napr... Je v scheme odpor s hodnotou vacsou ako 470k ? V akom obvode, ako je to citlive cele...
Pokial su pouzite suciastky v puzdre 0402, co dnes uz je bezne... skontrolvoalo sa u kazdej ci stratovy vykon (na rezistoroch) a napatie (kondik) nie su prekrocene... No a tak...

EMC je dalsia kapitola sama o sebe...