En teamhandbok ska hjälpa någon att slutföra en uppgift, inte bara bevisa att ett dokument finns. Börja med en återkommande rutin och en läsare som inte har lärt sig ert interna ordförråd.
Välj ett ofarligt exempel: att förbereda de godkända filerna för ett workshoppass. Målet är ett tydligt identifierat paket, inte en beskrivning av allt som företaget gör.
Definiera sidans uppgift
Skriv vem som använder sidan, vad de behöver innan de börjar och vilket synligt resultat som ska uppnås. Håll en rutin per sida, om inte närbesläktade åtgärder måste förklaras tillsammans.
Använd den här strukturen:
Syfte: förbereda det godkända workshopmaterialet. Innan du börjar: åtkomst till den aktiva mappen och passets identifierare. Åtgärder: hitta, granska, sammanställa och lämna över filerna. Klart: mottagaren kan identifiera rätt paket. Ägare: den person som godkänner ändringar i den här rutinen.
Förklara den dolda kunskapen
Håll utkik efter termer som bara erfarna kollegor förstår. Ange den faktiska platsen eller beslutsregeln i stället för att skriva ”använd den vanliga filen”. Om ett steg kräver behörighet, förklara vem som kan ge den.
Koppla skärmbilder till programvaruversionen och granskningsdatumet. En bild hjälper när den visar något som läsaren måste känna igen; den ersätter inte en beskrivning av åtgärden.
Gör uppdateringar spårbara och ansvarsfördelade
Ge sidan en ägare, en godkännandestatus och en utlösande faktor för granskning. En rutin kan behöva kontrolleras när ett verktyg ändras eller när verksamheten ändrar sin process. Dokumentera vad den nya versionen ersätter.
Om sidan innehåller olösta frågor, markera dem synligt. Få inte ett utkast att se godkänt ut bara för att hålla handboken prydlig.
Pröva en nybörjarövning
Ge sidan till någon som inte känner till uppgiften och låt personen arbeta med säkra exempelfiler. Lotsa inte personen genom varje dolt steg. Anteckna var personen tvekar, ställer en fråga eller väljer fel fil.
Använd dessa observationer för att förbättra instruktionerna och upprepa den berörda delen. En handbok blir användbar genom den här kontrollen och det här underhållet. Den behöver inte påstå att all företagskunskap automatiskt genomsöks eller hålls aktuell av AI.
Mika är ett redaktionellt författarnamn som används av redaktionen hos KENJTEC i Hamburg. Den här artikeln föreslår ett arbetsflöde; den redovisar inte ett genomfört test.
