Technical documentation validator

  • Popište specifika tvorby technické dokumentace.
  • Popište formáty používané pro tvorbu strukturované technické dokumentace. Vysvětlete význam sémantického značkování.
  • Popište význam průběžné integrace (CI) v kontextu tvorby technické dokumentace.
  • Prostudujte možnosti nabízené systémem Emender, který je určený pro deklaraci a spouštění testů nad dokumenty.
  • Navrhněte a implementujte test, který z dokumentů získá adresy odkazů, ověří dostupnost těchto odkazů a do výsledku testu zapíše seznam validních a seznam nevalidních odkazů. Podporovány by měl být formát DocBook. Test by měl taktéž sledovat, zda odkazy neodpovídají zadaným regulárním výrazům.
  • Navrhněte a implementujte test, který získá seznam názvů balíčků a ověří, zda zadané balíčky pro zvolený produkt existují. Seznam balíčků pro každý produkt je uložen v databázi. Podporován by měl být formát DocBook.
  • Navrhněte test pro kontrolu přepínačů použitých u příkazů nalezených v dokumentech (značka apod. v DocBooku). Seznam přepínačů pro jednotlivé příkazy by měl být automaticky generován pro každý podporovaný systém a měl by být vhodnou formou uložen v databázi.
  • Popište možnosti prezentace výsledků testů.
  • Navrhněte způsob navázání testovacího frameworku na systémy pro zajištění průběžné integrace (systém Jenkins atd.).
  • Výsledky testů spuštěných na zvolených technických dokumentech vhodným způsobem prezentujte a okomentujte.
  • Zhodnoťte dosažené výsledky a navrhněte možnosti dalšího vývoje projektu.
You must be logged in to perform this action!

Pavel Tišnovský

Team:
Location: Brno