Teknisk dokumentation
Dokumentera krav, konstruktion, test, resultat och ändringar så att en teknisk lösning går att förstå och följa. Genomgången kopplar begrepp till praktiskt tekniskt arbete och hjälper dig att motivera dina val.
- Nivå 1
- Nivå 2
- Nivå 3
Förstå → Se exempel → Träna
Förstå
Kärnan
Teknisk dokumentation skapar spårbarhet. Den gör det möjligt för andra att återskapa, granska, underhålla eller vidareutveckla en lösning.
Så arbetar du
Anpassa dokumentationen till syfte och mottagare och koppla text, tabeller, bilder och versioner till tydliga beslut och resultat.
Nyanser och begränsningar
Dokumentation ska vara tillräcklig och aktuell. Gamla ritningar eller otydliga versionsnamn kan vara mer riskfyllda än att information saknas helt.
I tekniskt arbete
Dokumentera antaganden, krav, metoder och resultat så att resonemanget går att följa. Skilj mellan vad som är uppmätt, beräknat, modellerat och bedömt.
Exempel
Exempel
- Efter ett prototyptest uppdateras ritning, komponentlista och testprotokoll med samma versionsnummer så att underlagen hör ihop.
- Koppla alltid slutsatsen till de krav, data eller observationer som faktiskt finns i uppgiften.
Så gör du
- 1Bestäm mottagare och vilket beslut eller arbete underlaget ska stödja.
- 2Välj rätt representationsform: text, skiss, ritning, modell eller diagram.
- 3Använd tydliga beteckningar, mått, enheter och versioner.
- 4Kontrollera att underlaget är entydigt och tekniskt konsekvent.
- 5Presentera slutsatser, begränsningar och nästa steg.
Vanliga misstag
Vanligt misstag
Att göra underlaget visuellt snyggt men tekniskt otydligt.
Bättre
Prioritera entydiga mått, beteckningar, versioner och relationer.
Teknisk kommunikation ska gå att använda.
Vanligt misstag
Att använda samma detaljnivå för alla mottagare.
Bättre
Anpassa urval och förklaring till mottagarens uppgift.
Fakta är desamma men presentationen kan skilja sig.
Fundera
Vilket antagande skulle vara viktigast att kontrollera i ett projekt där teknisk dokumentation är centralt?
Träna
Övning
Förklara hur du skulle använda kunskapen om teknisk dokumentation i ett konkret teknikprojekt.
Sammanfattning
- Dokumentera krav, konstruktion, test, resultat och ändringar så att en teknisk lösning går att förstå och följa.
- Motivera tekniska val med krav, modeller, tester eller tydliga kriterier.
- Gör antaganden och begränsningar synliga i dokumentationen.
- Utvärdera lösningen och var beredd att iterera när ny information kommer.
Relaterade genomgångar
Fortsätt med något som hänger ihop med den här genomgången.
Muntlig & skriftlig teknisk presentation
Presentera tekniska lösningar med tydlig struktur, relevanta data och anpassning till mottagare.
Läs genomgångenSkiss, ritning & modell
Välj mellan frihandsskiss, teknisk ritning och fysisk eller digital modell beroende på vilken information som ska kommuniceras.
Läs genomgångenLäsa & tolka tekniska underlag
Tolka ritningar, diagram, specifikationer och annan teknisk dokumentation för att förstå krav och samband.
Läs genomgången