Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dokumentácia existuje.
Každý ju píše po svojom:
Výsledok:
A hlavne:
rovnaké problémy sa riešia rôznymi spôsobmi.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Administrátorská príručka vznikala postupne.
Najprv core funkcionalita.
Potom klientská úprava.
Potom ďalší klient.
Po čase:
Typická otázka:
Platí toto pre všetkých, alebo len pre konkrétneho klienta?…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tím napíše manuál.
Pri prvej zmene funkcionality ho upraví.
Pri druhom klientovi ho rozšíri.
Pri treťom klientovi doplní výnimky.
Po čase:
A keď príde nový kolega:
„Platí toto pre všetkých?“…
Príklad šablóny:
Predmet: Objednávka č. {{order_id}} bola úspešne prijatá
Dobrý deň, {{customer_name}},
ďakujeme za Vašu objednávku. Tu sú jej podrobnosti:
• Produkt: {{product_name}}
• Množstvo: {{quantity}}
• Cena spolu: {{total_price}} €
Vaša objednávka bude odoslaná na adresu:
{{delivery_address}}
S pozdravom,
Tím {{company_name}}
Čo všetko otestovať:
1.…
