Braindumps kan vara en guldgruva Nu kanske du som känner mig börjar undra om jag har slagit hårt i huvudet? I alla fall du som hört mig beklaga mig över
Tabellen är teknikinformatörens bästa vän. Men bara om du gör den lättläst. Ett vanligt problem är att tabellen inte innehåller någon luft alls. Kanske i ett försök att spara plats?
Ibland visar du bara en liten detalj i bilden, ibland behöver du visa hela fönstret. Men hur stor och inzoomad bör bilden egentligen vara? Följ tips nummer fem i lilla skärmdumpsskolan
Eftersom du vet vad du menar, så tror du att läsaren tittar på samma sak i bilden som du själv gör. Det är ett klockrent fall av ”the curse of
Det är tyvärr inte vi skribenter som styr hur gränssnittet i mjukvaran ser ut. Eller vänta nu? I manualen är det vi som har makten… Här kommer tips nummer tre
Ofta behöver vi som skriver manualer ta skärmdumparna i någon slags test- eller QA-miljö för att hinna få manualen klar innan mjukvaran går i produktion. Och vi har nog alla
”Vi kan skicka över skärmdumpar till manualen”, hör jag ofta från mina uppdragsgivare när jag inte har tillgång till mjukvaran själv. Problemet är att de bilderna ofta är helt oanvändbara.
”Jag lovar, vi har gjort riskanalyser.” Ett sånt uttalande räcker inte långt vid en revision, om du inte kan visa upp dokumentationen som bevisar det. Och då kan hela projektet
Blir dina instruktioner långa och komplicerade? Det är lätt hänt, eftersom det ofta finns så mycket att förklara för användaren, annars hade du ju inte behövt skriva instruktionen från första
Jag fattar inte varför vår elbil inte har växlar, jag erkänner. Förut tänkte jag att den var automatväxlad, men vet numera att så inte är fallet. Den har helt enkelt
Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord
Genom att utgå från user stories får du en strategi som ger dig struktur när du skriver teknisk dokumentation. Det gör att det blir lättare att arbeta agilt med din dokumentation,
User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till
User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner
Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden
Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Står inte det i manualen? En manual
”Det måste gå att hitta ett system för det här!” Det var mitt mantra under många år. Och hittade jag ett system, ja då ville jag illa kvickt hitta ett
Ni har en agil utvecklingsprocess. Check.Ni har kanske till och med skickat ledningen på kurs och har nu en agil organisation i stort. Toppen! Men hur står det till med
Behöver du teknisk dokumentation för er mjukvara? Ta fram manualer och lathundar?
Se över policydokument?
Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.
Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden.
Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.
We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.
