Co je to chyba v dokumentaci?

Chyba v dokumentaci je jakákoli nesoulad mezi skutečným chováním produktu a jeho popisem v dokumentaci, nepřesnost, nejasnost nebo absence potřebných informací v technických dokumentech.

Příklady:

• Funkce funguje jinak, než je popsáno v uživatelské příručce.
• Specifikace API uvádí nesprávný formát odpovědi.
• Chybí popis nové funkce.
• Používají se zastaralá nebo neaktuální data.
• Gramatické a interpunkční chyby, které ztěžují porozumění.

Pro automatizaci hledání určitých typů chyb v dokumentaci (například odkazů na neexistující stránky nebo zastaralých termínů) lze použít speciální nástroje nebo skripty.

# Příklad jednoduchého skriptu pro kontrolu HTTP status kódů odkazů
import requests

def check_links(urls):
    for url in urls:
        try:
            response = requests.head(url, allow_redirects=True, timeout=5)  # Kontrola pouze hlavičky
            if response.status_code != 200:
                print(f"Nesprávný stavový kód {response.status_code} pro odkaz: {url}")
        except requests.exceptions.RequestException as e:
            print(f"Nelze ověřit odkaz {url}: {e}")

# Seznam odkazů ke kontrole
doc_links = [
    "https://example.com/docs/page1",
    "https://example.com/docs/nonexistent_page"
]

check_links(doc_links)

Objevování a oprava chyb v dokumentaci je důležitou součástí zajištění kvality produktu, protože nesprávná dokumentace může uvést uživatele a vývojáře v omyl, vést k nesprávnému použití produktu a snižovat jeho hodnotu.