Technická dokumentace - Technical documentation

Ve strojírenství technická dokumentace odkazuje na jakýkoli typ dokumentace který popisuje manipulaci, funkčnost a architekturu technického produktu nebo produktu pod rozvoj nebo použít.[1][2][3] Zamýšleným příjemcem technické dokumentace produktu je jak (zdatný) koncový uživatel stejně jako správce / služba nebo údržba technik. Na rozdíl od pouhé „kuchařky“ manuál Cílem technické dokumentace je poskytnout uživateli dostatek informací k pochopení vnitřních a vnějších závislostí daného produktu.

Li technické spisovatele jsou zaměstnáni v technologické společnosti, jejich úkolem je převést obvykle vysoce formalizovanou nebo zkrácenou technickou dokumentaci vytvořenou během vývojové fáze do čitelnější a uživatelsky přívětivější prózy.

Dokumentace doprovázející část technologie je často jediným prostředkem, kterým může uživatel plně porozumět dané technologii; bez ohledu na to je technická dokumentace vývojáři softwaru často považována za „nutné zlo“. V důsledku toho žánr trpěl tím, co někteří odborníci z oboru naříkají jako nedostatek pozornosti a přesnosti.[4] Psaní a údržba dokumentace zahrnuje mnoho technických a netechnických dovedností a tato práce se často nelíbí ani neodměňuje stejně jako psaní a údržba kódu.[5]

formuláře

Formuláře technické dokumentace mohou zahrnovat:

Během životního cyklu systému bude hrát významnou roli velké množství typů dokumentů:

a jejich různé zprostředkující nebo intervenující dokumenty.

Standardizace formulářů

Většina forem technické dokumentace tradičně postrádala uznávané standardy, i když se to mění.[4] Zatím, ISO vydala řadu standardy související s technickou dokumentací produktu a na tyto se vztahuje ICS 01.110.[6] Ty, na které se nevztahuje ICS 01.110, jsou uvedeny v podsekci níže.

Specifické pro obor

Předpisy EU

Technická dokumentace je vyžadována také pro následující zdravotnické prostředky Nařízení EU o zdravotnických prostředcích Příloha II a III nařízení popisuje obsah technické dokumentace pro a zdravotnické zařízení To zahrnuje např. informace o označování, designu, řízení rizik a klinickém hodnocení prostředku.

Formáty zdrojových dat

Viz také

Citace

  1. ^ Co je to „technická dokumentace“? na Transcom.de. Přístupné 25. února 2013.
  2. ^ Co je to technická dokumentace? Archivováno 2013-04-18 v Archiv. Dnes ve společnosti Tetras Translations. Přístupné 25. února 2013.
  3. ^ Dokumentace nového systému ve společnosti IGCSE ICT. Přístupné 25. února 2013.
  4. ^ A b Scéna dokumentace John Mobbs. Ústav vědeckých a technických komunikátorů, Pondělí 23. července 2012.
  5. ^ Geiger, R. Stuart; Varoquaux, Nelle; Mazel-Cabasse, Charlotte; Holdgraf, Chris (2018-05-29). "Typy, role a postupy dokumentace v knihovnách softwaru pro analýzu dat s otevřeným zdrojovým kódem". Počítačem podporovaná spolupráce (CSCW). 27 (3–6): 767–802. arXiv:1805.12398. doi:10.1007 / s10606-018-9333-1. ISSN  0925-9724. S2CID  44141371.
  6. ^ "01.110: Technická dokumentace k produktu". Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.
  7. ^ „ISO 15787: 2001 Technická dokumentace k produktu - Tepelně ošetřené železné díly - Prezentace a indikace“. Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.
  8. ^ „ISO 3098-0: 1997 Technická dokumentace k produktu - Nápisy - Část 0: Obecné požadavky“. Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.
  9. ^ „ISO 10209-1: 1992 Technická dokumentace produktu - Slovník - Část 1: Pojmy týkající se technických výkresů: obecné a typy výkresů“. Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.
  10. ^ „ISO 2162-1: 1993 Technická dokumentace k produktu - Pružiny - Část 1: Zjednodušené znázornění“. Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.
  11. ^ "ISO 5457: 1999 Technická dokumentace produktu - Velikosti a rozložení výkresových listů". Mezinárodní organizace pro normalizaci. Citováno 10. června 2009.