Mis on viga dokumentatsioonis?

Dokumentatsiooni viga on iga sobimatus tootega seotud käitumise ja selle kirjelduse vahel dokumentatsioonis, täpsus, kahtlus või vajaliku teabe puudumine tehnilistes dokumentides.

Näited:

• Funktsioon töötab teisiti kui kasutusjuhendis kirjeldatud.
• API spetsifikatsioonis on vale vastuse vorming.
• Uue funktsiooni kirjeldus puudub.
• Kasutatakse vananenud või mitteaktiivseid andmeid.
• Grammatikavead ja kirjavahemärgi vead, mis raskendavad mõistmist.

Teatud tüüpi vigade (näiteks mitteolemasolevatele lehtedele viitavate linkide või vananenud terminite) automaatseks tuvastamiseks dokumentatsioonis saab kasutada spetsiaalseid tööriistu või skripte.

# Näide lihtsast skriptist, mis kontrollib HTTP-olekukoode linkide jaoks
import requests

def check_links(urls):
    for url in urls:
        try:
            response = requests.head(url, allow_redirects=True, timeout=5)  # Kontrollib ainult päist
            if response.status_code != 200:
                print(f"Vale staatusekood {response.status_code} lingil: {url}")
        except requests.exceptions.RequestException as e:
            print(f"Ei õnnestunud kontrollida linki {url}: {e}")

# Kontrollitavate linkide nimekiri
doc_links = [
    "https://example.com/docs/page1",
    "https://example.com/docs/nonexistent_page"
]

check_links(doc_links)

Vigade avastamine ja parandamine dokumentatsioonis on oluline osa toote kvaliteedi tagamisest, kuna ebatäpsed dokumendid võivad kasutajaid ja arendajaid eksitada ning viia toote vale kasutamiseni ning selle väärtuse vähenemiseni.