Försvar för enkla verktyg – del 3: Skrivverktyg
Om en informationsmodell skall vara mer än en första skiss så räcker det inte med ett diagram. Vi behöver också text, strukturerad text. Man brukar säga att en bild uttrycker mer än tusen ord. Men vi bör då också säga att en mening säger mer än tusen bilder. Samt att text och bild tillsammans, där text och bild är tätt integrerat, ger oss möjlighet till riktigt kraftfulla uttrycksformer. Därför är Microsoft Word ett utmärkt modelleringsverktyg.
/Peter Tallungs, IRM, 2021-04-29
Ofta möter man informationsmodeller som bara är ett diagram, det vill säga boxar sammanlänkade med linjer. Det kan vara ER-diagram eller klassdiagram i UML. ER-diagram eller klassdiagram i UML är visserligen centrala för en informationsmodell. Ett diagram av det slaget ger den överblick vi behöver. Men det finns många saker som uttrycks bäst i text eller som endast går att uttrycka i text.
Vi ska inte begränsa vår verktygslåda utan vi ska utnyttja och kombinera alla uttrycksmedel som vi behöver. Vi behöver då kombinera text och bild, och göra det tätt tillsammans, så att de stödjer varandra.
Till detta behöver vi ett kraftfullt och flexibelt dokumentationsverktyg. Tro det eller ej, men ett sådant har vi redan på skrivbordet i form av ett ordbehandlingsverktyg som till exempel Microsoft Word.
Våra modeller är dokument med allt vad det innebär
Ofta möter man villfarelsen att textdokument är en relik från papperseran. Man tror att nu när allt är elektroniskt behöver vi inte skriva dokument längre. Det är inte sant. Rent allmänt är ett dokument något som vi skapar, betraktar och håller ihop, som en enhet. Det kan vara en artikel, en film, ett nummer av en tidning, en ljudfil, en bok. Vilken typ av innehåll i vilket medium som helst. Begreppet blir inte överflödigt i en digital värld. Tvärtom blir det till och med viktigare vad vi håller ihop som en enhet, eftersom saker och ting kanske inte av sig själv får en lika självklar paketering som i pappersvärlden.
I vår värld som modellerare är en modell alltid att betrakta som ett dokument, rent konceptuellt. En modell är något som vi vill se som en sammanhållen enhet, även om den rent fysiskt finns i ett antal filer. Om man till exempel delat ner en modell i ämnesområden, kan varje ämnesområde också beskrivas av ett eget konceptuellt dokument. Vi kan alltså ha dokument i dokument.
Innehåll i ett modelldokument
Vad kan då ett modelldokument, det vill säga ett dokument som bär en modell eller en del av en modell, innehålla? Vilka strukturer behöver ett modelldokument ha? Och vad behöver våra modelldokument ha för metadata, de vill säga data om dokumentet i sig? Låt oss titta på det. Jag visar exempel på hur man kan tillgodose de behoven i ett Word-dokument. Med det vill jag visa hur perfekt lämpat ett ordbehandlingsverktyg är för den uppgiften.
Man behöver inte göra precis som jag. Det jag visar är endast exempel på hur man kan göra för att tillgodose de dokumentationsbehov vi som modellerare har.
Jag ger exempel utan att närmare gå in på exakt hur man kan strukturera en informationsmodell. Syftet är nu endast att visa att vi vid sidan av diagram behöver strukturerad text i våra modeller och att vi behöver integrera text och bild. Samt att vi behöver se våra modeller som dokument med allt vad det för med sig. Och att ett ordbehandlingsprogram är ett utmärkt verktyg för detta.
Strukturerad text
Texten i ett modelldokument för ett visst ämnesområde behöver vara strukturerad. Jag beskriver varje entitet, attribut och relation med ett antal fasta rubriker i en hierarkisk struktur.
Värdemängder för attributvärden
Jag beskriver även varje attributvärde för attribut med en fast värdemängd.
Integrerad text och bild
Det är viktigt att kunna integrera text och bild, det vill säga att man kan beskriva något både verbalt och visuellt tillsammans på ett och samma ställe.
Ett ordbehandlingsverktyg är utmärkt för att integrera text och bild. Du kan lätt klippa in de illustrationer du behöver.
Dokumentmetadata
Vi behöver beskriva vad dokumentet innehåller, i vilket sammanhang det tagits fram, av vem och så vidare. Vi kan kalla det för dokumentmetadata. Ofta glöms det bort. Modeller görs av personer inte organisationer.
- Rubrik och underrubrik
- Att det är en informations-modell och vad den beskriver.
- Filnamn
- Version Nummer och/eller datum
- Vem som gjort modellen
- När modellen gjordes
- I vilket sammanhang modellen gjordes
Dessutom kan även följande behövas:
- Vilka källor som modellen baseras på
- Exempel: Baserad på intervjuer med it- och verksamhetspersonal. Analyser och genomgång av centrala it-system.
- Vilka avgränsningar eller antaganden som gjorts
- Exempel: Modellen har gjorts innan och utan hänsyn till de planerade integrationerna med de centrala produkterna och kundsystemen.
- Hur man läser modellen
- Här kan man tänka sig en beskrivning av speciella symboler och ritsätt.
Ändringshistorik
Ett ämnesområde i en modell har en historia. Du behöver beskriva vilka ändringar som gjorts, när, av vem och ofta varför. Denna historik är en viktig del av dokumentet och bör därför alltid finnas med i själva dokumentet och inte skilt från dokumentet som i ett versionshanteringssystem.
Noteringar
Det är viktigt med noteringar. Det är det som mer än något annat kan göra modellen till en plattform för ett gemensamt lärande. Med noteringar blir modellen inte bara en dokumentation av slutresultatet utan också hur resonemanget har gått, vilka beslut som tagits i enskilda frågor, vilka utestående frågor som finns och vad olika personer har sagt i dessa frågor. På så sätt blir modellen ett gemensamt arbetsverktyg, en plattform för det gemensamma lärandet.
Innehållsförteckning
Innehållsförteckning ger en översikt och förmedlar strukturen på dokumentet.
Sakregister
Sakregister kan man bygga för att skapa ett navigeringshjälpmedel i ett större dokument eller över en grupp av sammanhållna dokument. Ett sakregister är inte samma som textsökning, eftersom uppslagsorden leder dig till det bästa stället eller ställena för att läsa om ett ämne.
Varför ett skrivverktyg
Allt detta som är beskrivet ovan är inte ritverktyg bra på, och inte heller de specialiserade modelleringsverktygen. Men det är ordbehandlingsprogrammens hemmaplan. De är fullfjädrade dokumentationsverktyg. Därför låter jag alltid stommen i en informationsmodell bestå av ett Word-dokument eller, för större modeller, ett Word-dokument för varje ämnesområde. Själva diagrammen ritar jag i Microsoft Visio och sparar inbäddade i textdokumenten eller, i det fall de blir för stora för att rymmas på en stående A4, som bilagor till textdokumenten.
Vilka verktyg använder du? Hur dokumenterar det jag beskriver i artikeln? Vilka dokumentationsbehov har jag glömt tycker du? Kommentera gärna! Jag ser fram mot en dialog.
/Peter Tallungs, IRM
