Skrivinstruktioner för RA-dokument

Transkript

1 Skrivinstruktioner för RA-dokument 1 (5)

2 1.1 Allmänt Detta dokument ska ses som riktlinjer för upprättande och uppdatering av RA-dokument samt mall för de texter som ska skrivas. Ingen dokumentinformation (formalia) behöver skrivas in manuellt i dokumenten. All dokumentinformation hämtas från egenskapstaggningen i GBP och skrivs automatiskt via meta-taggarna. D.v.s. sidfötter, sidhuvuden samt försättssidor i anvisnings-, informations-, eller ändrings-pm-dokument ska lämnas orörda. 1.2 Dokumenttyper Följande dokumenttyper finns för RA: anvisningar mallar checklistor exempel information ändrings-pm Anvisningar, exempel, information och ändrings-pm ska publiceras i låsta i pdf-format. Mallar och checklistor ska publiceras i ändringsbara format, t.ex. word, excel, o.d. 1.3 Dokumentmallar För RA finns följande mallar: mall för anvisning (stående A4 (Word)) mall för anvisning (liggande A4 (Word)) mall för mall/checklista/exempel (stående A4 (Word)) mall för mall/checklista/exempel (stående A4 (Excel)) mall för information (stående A4 (Word)). mall för ändrings-pm (stående A4 (Word)). Behovet styr vilka övriga mallar som ska tas fram. 1.4 Dokumentstruktur och format Rubriker och rubriknivåer Databasen bygger inte på rubriknivåer däremot kan rubriker användas för att strukturera innehållet i ett dokument. Rubriker i ett dokument kan användas för att skapa begripliga helheter. Följande rubriknivåer används: 1. Huvudrubrik Kan också användas för huvuddel inom ett dokument. 2 (5)

3 1.2 Rubriknivå Rubrik nivå 3 Rubrik nivå 4 Här slutar rubriker att vara numrerade om det inte av ämnets karaktär bedöms vara nödvändigt. Rubriknivå 5 Om en femte rubriknivå behövs i texten anges den som fet kursiv Rubriknivå 6 Behöver man en sjätte nivå anges den som kursiv Texter Texter skall skrivas så att de beskriver en meningsfull helhet. Texterna ska inte bara förklara att vissa saker ska ske på ett visst sätt utan även varför. Detta för att öka förståelsen för de texter vi skriver in i anvisningarna. Texter bör vara korta och koncisa. Om texter blir långa bör en bedömning om det av sammanhanget bör vara ett stort dokument eller om det är lämpligt att dela in dokumentet i relevanta och kompletta delar. Uppdelning av dokument kan göras exempelvis i det fall det finns omfattande dokument avseende olika byggnadstyper eller då olika anvisningar initialt inte är samordnade. Text skrivs i 12pt Times New Roman, all text skall vara vänsterjusterad. (En blankrad här) Mellan stycken en (1) blankrad. I övrigt enligt rubrikernas standard. (En blankrad här) Ordning efter byggnadstyp Om flera byggnadstyper berörs av separat information i samma dokument skall nedanstående ordning användas när detta tas upp. Observera att undergrupper bara skall användas när information skiljer sig åt och detta behöver förtydligas. Om materialet blir mycket omfattande bör ett separat dokument övervägas. Följande ordning ska användas: Skolor o förskola o grundskola grundskola F-3 grundskola 4-9 o gymnasieskola boende o BmSS o äldreboende kontor. 3 (5)

4 1.4.4 Innehållsförteckning Dokument kan förses med innehållsförteckning om det underlättar för läsare att hitta i dokument. Avgörs från fall till fall Tabeller Tabeller som skall läggas in i texten görs enligt nedan med numrerad tabelltext ovan tabell: Tabell 1. Tabell över siffror. Rubrik läggs alltid direkt ovan tabell. Kolumn 1 Kolumn 2 Kolumn 3 Kolumn 4 Kolumn Bilder Bilder läggs in enligt nedan med numrerad bildtext ovan bild: Figur 1. Figur-/bildtext läggs alltid ovan med en blankrad mellan text och figur/bild Listor i text Punktlistor ska se ut på detta sätt: Ytterdörrar o dörrar av metall o dörrar av trä innerdörrar o innedörrar med glas specialdörrar o dörrar med tittöga o dörrar med kattlucka Externa länkar Länkar markeras med dess kompletta adress, dvs. inte 4 (5)

5 1.4.8 Hänvisning till andra RA-dokument Hänvisning till andra RA-dokument utförs med apostrofer runt dokumentnamnet, t.ex. Principer för energi- och volymmätning Referenser Referenser skall vara korrekta och kompletta. De kan antingen refereras till löpande eller läggas sist i lista i bokstavsordning efter författare. Om de läggs löpande i texten skall detta anges inom parantes enligt följande (Johansson, J, 2009, Våtrumsutrymmen, s.23) Citat Citat skall noteras på följande sätt: Lagen om offentlig upphandling gäller för alla sådana upphandlingar som har offentlig beställare (LOU. Kap 1, s 3) 5 (5)