česky english Vítejte, dnes je pátek 29. březen 2024

3 Tipy tvorby dokumentace

17.12. 2019 | Zprávy
Autor: Radek Řezníček
ZakladniKrokyDokumentace.png

Vytváření dokumentace zcela jistě není nejzábavnější součást vývoje, ale řekněme, že je výhodné vytvářené věci dokumentovat. Investovat čas do dokumentace se vyplatí nejenom pro případ dalších změno (postupného vývoje), ale také v případě oprav, nutnosti dodržet, přesný postup nebo střídání pracovníků provádějících výrobní úkony.

Dokumentace nejenom, že uchovává důležité koncepty vývoje, ale umožňuje také nadhled nad provedenou prací a její zpětné zhodnocení. Důležitým tipem číslo jedna, je proto vytvářet dokumentaci, dokud máme provedený úkon v paměti. Například změna hodnoty rezistoru ve schématu (jeho variantě) nebo způsob vedení měděné cesty na desce má většinou smysl a tento smysl je potřeba zachytit, dokud máme důvody k němu stále v paměti. Kde jinde myšlenkový pochod zaznamenat než poznámkou v dokumentaci. Dostanete-li se k tvorbě dokumentace až po odevzdání desky do výroby, nebudete vědět detaily, jaké k rozhodnutí o změně vedly.

Elektronická dokumentace v případě jejího postupného vytváření a změn v průběhu vývoje skýtá jedinečný nástroj pro záznam menších nápadů i zásadních změn. Propojení a odkazy na software, ve kterém je projekt vytvářen, je další výhodou. Prakticky nepostradatelná je funkce vyhledávání (Ctrl+F). Nepředpokládám, že mnoho komerčních projektů v dnešní době vzniká na papíře.

ZakladniKrokyDokumentaceOdkazy

Popsaný postup tvorby s hypertextovými (křížovými) odkazy na jednotlivé části a okno vyhledávání z programu BluePrint-PCB pro dokumentování vývoje a výroby DPS

Druhým tipem je jistě známá a používaná fráze: „Jeden obrázek vydá za 1 000 slov.“ Přesto existují dokumentace, které preferují popis pomocí textu před fotkou nebo názornou grafikou. Popis obrázku je samozřejmě také důležitý. Nejlépe pokud je obsažen přímo v obrázku a vysvětluje jeho části. Načtení libovolného množství obrázků, popisujících postupy vytváření je proto jednou ze základních schopností dokumentace.

ZakladniKrokyDokumentaceObrazky

Ukázka podrobné dokuemntace výroby pomocí obrázků a popisků v programu BluePrint-PCB pro dokumentování vývoje a výroby DPS

Posledním tipem v článku je nechat si vytvořenou dokumentace zkontrolovat kolegou nebo ještě lépe někým, kdo nemá k dispozici informace o dokumentovaném projektu. Záleží samozřejmě na účelu dokumentace, zda má poskytnout vhled někomu, kdo s projektem přišel do styku poprvé nebo detailní poustup výroby či použití. Každopádně je výhodné mít názor někoho dalšího, zda vám nechybí nějaká zásadní informace.

Přestože se jedná o všeobecně známé poučky jejich dodržení není samozřejmostí. Dokáží vám ušetřit řadu nepříjemností se vzpomínáním co jste provedenou změnou zamýšleli nebo dokonce při úplném opomenutí vytvoření dokumentace, vzpomínání, kde co v projektu je.

radek@cadware.cz