Sjabloon voor probleemoplossingsartikelen
door Atlassian
Documenteer veelvoorkomende problemen en de oplossingen ervoor
Help klanten met veelvoorkomende problemen en laat ze zelf oplossingen vinden in door jouw geschreven probleemoplossingsartikelen. Onze sjabloon voor probleemoplossingsartikelen biedt je de structuur die je nodig hebt om het probleem te verwoorden, de oplossing nauwkeurig te beschrijven en gerelateerde artikelen te tonen (wat je automatisch kan doen door labels en de macro Content-per-label te gebruiken om gerelateerde artikelen te blijven volgen). Leer ze hun eigen boontjes te doppen en geef je supportteam meer tijd om complexere taken af te handelen.
Het Probleemoplossingsartikel-sjabloon gebruiken
Stap 1. Beschrijf het probleem
Met een artikel zoals dit is het verleidelijk om je meteen op de oplossing te storten, maar het probleem beschrijven is een cruciaal onderdeel van het schrijven van effectieve content. Lezers moeten kunnen zeggen of het artikel de problemen benoemt die ze ervaren. Probeer je voor te stellen hoe je doelgroep dit probleem ervaart en leg het probleem uit met terminologie en voorbeelden die relevant zijn voor die ervaringen.
Stap 2. Geef een stapsgewijze oplossing
Als je het probleem hebt beschreven, is het daarna tijd om uit te leggen hoe je het kunt oplossen. Gebruik met behulp van een genummerde lijst een stapsgewijze oplossing. Gebruik termen die lezers kennen en begrijpen en behandel een stap per keer. Illustreer waar mogelijk de stappen met afbeeldingen. Zo weten mensen die je artikel lezen hoe dingen eruit moeten zien tijdens elke stap. Als er meer dan een oplossing mogelijk is, kun je in je artikel het beste kiezen voor de meest toegepaste oplossing. Als je denkt dat het nodig is om mensen meer opties te geven, kun je een opvouwbaar venster maken waar je de andere oplossingen neer kunt zetten.
Stap 3. Geef gerelateerde artikelen weer
Soms kom je een artikel tegen over een probleem dat vergelijkbaar is met dat van jou, maar niet helemaal hetzelfde is. En soms kun je later problemen voorkomen omdat je al weet hoe iets werkt. Door labels toe te passen in je probleemoplossingsartikelen en content per labelmacro (zijn al opgenomen in deze sjabloon) te gebruiken, kun je automatisch gerelateerde artikelen en pagina's weergeven. Let erop dat je hetzelfde label voor alle gerelateerde pagina's gebruikt.
Atlassian is een softwarebedrijf dat producten voor softwareontwikkelaars, projectmanagers en contentbeheer ontwikkelt.
Meer Softwareontwikkeling/IT sjablonen Alles weergeven
-
Lucidchart
Diagram van AWS-architectuur
Visualiseer je infrastructuur om zwakke punten en verbeterpunten beter in kaart te brengen.
-
Atlassian
Ontwerp je ideale werkweek
Bied een stapsgewijze handleiding voor het voltooien van een taak.
-
Atlassian
DevOps-runbook
Bereid je operationsteam voor om snel te reageren op systeemmeldingen en onderbrekingen.