Vi på teknikinformation har tagit fram en
checklista med de viktigaste punkterna att tänka
på när du skapar teknisk dokumentation.
Checklistan är mycket generell och det är upp
till dig själv att fördjupa kontrollen.
- Produkt
- vilken produkt och utrustning ska
dokumenteras?
- Grundmaterial
- vilken information finns om produkten i
form av manualer, tekniska underlag,
teknisk specifikation, säljmaterial,
möjlighet till intervju av
produktutvecklare?
- Risker
- vilka säkerhetsrisker för personer
och material finns i samband med
produkten?
- Målgrupp
- vilka målgrupper ska använda
informationen? Vilka arbetsuppgifter ska
de utföra, vilken information behöver
respektive målgrupp för att göra det?
- Användning
- hur ska informationen användas? I
vilka situationer?
- Pedagogik
- vilken förkunskapsnivå har
målgruppen? Ställer
användningssitutationen speciella krav
på pedagogik, symboler mm?
- Översättning
- ska informationen förberedas för
anpassning till andra språk?
- Media
- hur kan informationen presenteras?
Trycksak, video, CD-ROM, hjälpfil?
- Program och
system - finns det krav på
att vi ska jobba eller leverera i
speciella programformat (Word etc), eller
speciella datormiljöer (Windows, Mac
etc)
- Utformning
- för trycksaker, vilka format kan
användas, tryckmetoder, färger?
- Speciella krav -
finns grafiska riktlinjer, definierad
dokumentstruktur, normer, standarder som
ska följas?
- Leveranstid
- när ska informationen vara klar, och i
vilken form ska den levereras?
- Resurser
- vilka resurser har kunden för
produktionen i form av egen personal och
tekniska hjälpmedel, budget för externa
tjänster?
- Administration
- Offert, beställning, fakturering
|