Článek z vyřešeného technického tiketu má popsat jeden příznak, ověřené prostředí, otestovanou nápravu a kontrolu výsledku. Odstraňte zákaznické údaje a používejte postup jen pro doložené podmínky.
Vyberte reprodukovatelný případ
Příčina, náprava a výsledek musejí být potvrzené. Uzavřený tiket sám nedokazuje úspěch. Bez potvrzení zákazníka nebo testu neoznačujte návod za ověřený.
Vyberte jeden příznak. Různé problémy nespojujte jen kvůli stejnému týmu podpory.
Anonymizujte podklady
Odstraňte jména, adresy, soukromé dokumenty, čísla účtů, identifikátory relací a technická tajemství. Obrázky zkontrolujte zvlášť.
Ponechte nutné údaje o produktu, verzi, prostředí, příznaku a podmínce vzniku. Konfiguraci identifikující zákazníka popište bezpečně při zachování příčiny. Nezveřejňujte korespondenci.
Použijte strukturu příznak–prostředí–náprava
- Příznak: co uživatel vidí a kdy.
- Prostředí: produkt, verze, systém a relevantní nastavení.
- Podmínka shody: jak poznat odpovídající případ.
- Náprava: kroky ověřené pro tento případ.
- Kontrola: očekávaný úspěšný výsledek.
- Hranice a eskalace: kdy skončit nebo oslovit podporu.
Diagnostika není náprava a sběr údajů není řešení. U ochrany dat odkažte na skutečný potvrzený postup produktu.
Fiktivní příklad článku
Nejde o chybu Semly. V dokumentové aplikaci 2.4.0 se po potvrzené změně oprávnění neukázal nový dokument v již otevřeném seznamu. Obnovení aktualizovalo seznam, neměnilo oprávnění.
Prostředím je relace zahájená před změnou. Podmínkou shody je, že dokument existuje v nově otevřeném pohledu pro stejný účet.
Uložte rozpracovanou práci a obnovte pohled podle návodu aplikace. Ověřte, že se dokument ukáže a otevře se správným oprávněním. Pokud chybí i v novém pohledu, tento případ není potvrzen a je třeba další diagnostika.
Napište omezení
Uvádějte pouze testované verze a nastavení. Podobné rozhraní nedokazuje podporu další platformy.
Obnovení neslibuje opravu oprávnění nebo chybějících dat. Pro jiné příčiny platí jiné postupy. Podmínka shody brání zbytečnému opakování kroků.
Otestujte text očima uživatele
Technický recenzent bezpečně zopakuje případ a postupuje podle článku bez znalosti tiketu. Zkontrolujte podmínky i definici úspěchu.
Chybějící údaje doplňte do prostředí a podmínek. Návod nesmí záviset na znalostech dostupných jen autorovi.
Evidujte ověření a překlady
Zapište datum a vlastníka ověření. Po změně produktu prověřte kroky znovu.
Překlady zachovávají verzi, příznak, pořadí a výsledek. Zprávy musejí odpovídat skutečnému rozhraní. Jiná příčina a řešení patří do jiného případu, nikoli do nesouvisejícího dodatku.
