Čo je chyba v dokumentácii?

Chyba v dokumentácii je akékoľvek nesúlad medzi skutočným správaním produktu a jeho popisom v dokumentácii, nepresnosť, nejasnosť alebo absencia potrebných informácií v technických dokumentoch.

Príklady:

• Funkcia funguje inak, než je opísané v používateľskej príručke.
• Špecifikácia API uvádza nesprávny formát odpovede.
• Chýba popis novej funkcie.
• Používajú sa zastarané alebo neaktuálne údaje.
• Gramatické a interpunkčné chyby, ktoré sťažujú porozumenie.

Na automatizáciu vyhľadávania určitých typov chýb v dokumentácii (napríklad odkazov na neexistujúce stránky alebo zastarané termíny) môžu byť použité špeciálne nástroje alebo skripty.

# Príklad jednoduchého skriptu na kontrolu HTTP stavových kódov odkazov
import requests

def check_links(urls):
    for url in urls:
        try:
            response = requests.head(url, allow_redirects=True, timeout=5)  # Kontrola iba hlavičky
            if response.status_code != 200:
                print(f"Nesprávny stavový kód {response.status_code} pre odkaz: {url}")
        except requests.exceptions.RequestException as e:
            print(f"Nemožno overiť odkaz {url}: {e}")

# Zoznam odkazov na kontrolu
doc_links = [
    "https://example.com/docs/page1",
    "https://example.com/docs/nonexistent_page"
]

check_links(doc_links)

Objavovanie a oprava chýb v dokumentácii je dôležitou súčasťou zabezpečenia kvality produktu, pretože nesprávna dokumentácia môže uviesť používateľov a vývojárov do omylu, viesť k nesprávnemu používaniu produktu a znižovať jeho hodnotu.