|
|
|
|
LineOne
Redactie
Richtlijnen
|
|
1. Inleiding |
|
|
|
1.1 Doel van dit document |
|
|
|
|
|
doel |
Doel van dit document is het geven van redactionele richtlijnen voor het maken van uniforme, snel toegankelijke handboeken.
|
|
naslag |
Redactie Richtlijnen is een naslagwerk. Een naslagwerk voor de gebruiker, voor jou dus. De gebruikers
zijn in principe jullie allemaal. Allen die namens je bedrijf of afdeling documenten schrijven.
|
| top /
menu
|
1.2 Algemeen |
| |
|
standaards |
Het maken, maar ook het lezen van documenten is een zich steeds herhalend proces.
Net als bij elk werkproces zijn jij en de lezer gebaat bij een hoge mate van standaardisatie.
Dit geldt voor de wijze waarop je de inhoud van het document maakt en vormgeeft. Het geldt ook voor de wijze waarop je het document toegankelijk maakt door padnamen, nummering, indexen, koppen enzovoort.
Latere bewerker, beheerder en gebruiker vinden daardoor doeltreffender en efficiënter de
documentonderdelen. Ze herkennen gemakkelijker de opbouw en vinden sneller hun informatie.
|
|
modules |
Inhoud en ontsluiting gaan uit van een modulaire opbouw.
Ten opzichte van een conventionele tekst is zo'n modulaire tekst
* eenvoudiger op te nemen en te begrijpen
* gemakkelijker te onderhouden
* directer terug te vinden en te herzien.
De extra mogelijkheden die het gebruik van hyperlinks (onderlinge verbindingen) bij eigentijdse
electronise toepassingen geeft versterkt die voordelen.
Een modulaire opbouw houdt in:
* het opdelen van informatie in kleine tekstblokken
* het aan elkaar verbinden van gerelateerde teksten
* het eenmalig vastleggen van repeterende informatie
|
|
dwaalwegen |
Wat vermeden kan worden moet je vermijden.
* een drang naar overvolledigheid op paragraafniveau ("Als ze het hier niet vinden, dan zien ze het misschien over het
hoofd.")
* het willen tegengaan van verwijzingen naar andere bladzijden of andere documentatie ("Anders moeten ze steeds maar
bladeren.")
* verschillende auteurs die hetzelfde onderwerp verschillend beschrijven.
Eenmalig vastleggen van een onderwerp bevordert niet alleen de eenduidigheid en betrouwbaarheid, maar ook het overzicht en het beheersgemak.
|
|
voortschrijdende standaards |
Als je gelijksoortige informatie op vaste plaatsen bij elkaar zet, dwing je de analyserende en herschrijvende redacteur om ook in blokstructuren en gedefinieerde modules te denken. Daarmee kan hij al tijdens het analyseren van het basismateriaal stukjes informatie ordenen in vakjes waar ze thuishoren en tegelijkertijd dergelijke passages 'wegstrepen' uit de te herschrijven documentatie. Haast vanzelfsprekend komen overlappingen en herhalingen op den duur steeds in hetzelfde vakje. Zo kan je door het maken van een goede basisstructuur meehelpen aan het efficiënt herbouwen van de informatie naar een hecht samenhangend en gestandaardiseerd geheel.
|
|
top /
menu
|
1.3 De inhoud |
| |
|
soorten inhoud |
Het is kenmerkend voor documenten, dat zij verschillende soorten informatie bevatten:
|
|
richtlijnen per soort |
| * |
platte tekst: zinnen en alinea's |
| * |
gestructureerde informatie: opsommingen, tabellen en schema's, blokken, modules |
| * |
structurerende teksten: kop- en voetteksten, onder- en bovenschriften, koppen, inhoud en indexen, verwijzingen, hyperlinks |
| * |
formulieren (interactieve teksten met invulruimte) |
Voor elk type inhoud krijg je redactionele richtlijnen. Deze staan beschreven in de bijbehorende paragrafen.
De richtlijnen mag je in elk soort document toe passen, tenzij in een sjabloon een afwijkende vorm dwingend is opgelegd.
Het maken of bewerken van documenten is meestal geen doorlopende procedure. Als gebruiker kies je slechts de benodigde stappen.
|
| top /
menu
|
2. Stappen bij het maken van documenten |
|
|
2.1 Kiezen van sjabloon |
| |
|
stap 1 |
Bepaal of het een gedefinieerd soort document wordt.
|
|
stap 2 |
Vraag het passende standaardsjabloon op (zie onderstaande tabel).
|
|
stap 3 |
Bij gebrek aan een passend sjabloon worden de regels per onderdeel gehanteerd, zoals in deze handleiding beschreven.
Tabel 1. Documenten/sjablonen (Let op: Onderstaande tabel is zelf
in te vullen)
| nr. |
soort documentsjabloon met hyperlink |
| |
Globaal Processchema |
| |
Detail Processchema |
| |
Werkinstructie |
| |
etc |
| |
|
toelichting:
|
|
sjabloon afdeling |
De productie van elk gedefinieerd soort document start je met een standaardsjabloon.
|
|
sjabloon bedrijf |
Als voor een soort document geen specifiek sjabloon is gemaakt voor je eigen afdeling (zie bovenstaande tabel), dan gebruik je de standaardsjabloon van
je bedrijf.
|
|
geen sjabloon |
Als binnen je eigen bedrijf geen standaardsjabloon beschikbaar is gebruik je de algemene sjabloon van de tekstverwerker, met inachtneming van deze Richtlijnen Redactie.
Het volgende geeft daartoe een overzicht.
|
| top /
menu
|
3. Invullen van standaardonderdelen in een document
|
|
|
|
3.1 Kop- en voettekst |
|
|
|
|
aanmaak |
In 'Word' maak je kop- en voettekst aan via 'Beeld/Koptekst en
Voettekst'.
Kopieer en plak het voorbeeld aan het eind van deze paragraaf .
Sommige standaarddocumenten hebben geen kop- en voettekst maar een (brief)hoofd.
|
|
kopgegevens |
Gebruik voor een koptekst dezelfde tekstkenmerken als voor een standaarddocument.
Een koptekst bevat altijd:
* het logo van je bedrijf
* de productnaam waar het document onder valt
* de documentnaam
* het documentnummer (databank)
Type de actuele gegevens achter de labels.
|
|
voetgegevens |
Voetteksten gebruik je alleen als er na de eerste pagina geen koptekst meer wordt geplaatst.
Een voettekst wordt rechts uitgelijnd.
Gebruik voor een voettekst dezelfde tekstkenmerken als voor een standaarddocument.
Een voettekst bevat altijd:
* de documentnaam.
* de uitgiftedatum van de versie
* het paginanummer
De voettekst plaats je op elke pagina.
Voorbeeld van een koptekst: (met linksboven het bedrijfslogo )
|
F
|
|
Projekt : b.v. Operations
Procesman. -Werkinstr. |
|
Datum : 01-09-01 |
|
Onderwerp : b.v. Telebankieren |
|
Versie : 0.1 |
|
auteur:
G. Poortinga |
|
Blad : 1 |
|
|
voeg separaat paginanummer in |
Een paginanummer zet je in de kop of voettekst. Alleen als er geen kop- of voettekst is en als het document niet beperkt blijft tot 1 pagina, zet je apart een paginanummer.
Je zet het paginanummer rechts onderaan.
Paginanummers zet je in de standaard tekstletter.
voorbeeld van een
voettekst:
Redactie Richtlijnen 2001, pg. 4
|
|
top /
menu
|
|
3.2 Titel |
|
|
|
plaats |
Grotere documenten geef je een afzonderlijke titelpagina.
Daar zet je minimaal de titel.
|
|
lettertype |
Je gebruikt het standaardlettertype van de bank (momenteel Times Roman).
Bij Word kan een titel opgemaakt worden via het opmaakmenu (uitklapmenu links keuze 'titel'). De
voorkeurgrootte van de letter in de titel is 28 punten.
|
|
content |
Geef in de titel zo nauwkeurig mogelijk aan waar het document over gaat.
De titel van elk (deel)handboek bevat het woord 'handboek', een aanduiding van het proces dat wordt behandeld en een indicatie voor het gebruikersniveau. Bijvoorbeeld: 'Handboek Bedrijfssparen Werkinstructies' of 'Handboek Effecten Procesanalyses'.
|
|
ondertitels |
Als het document in gedeelten wordt aangeboden, geef je elk deel een ondertitel. Ook de ondertitel bevat een duidelijke aanwijzing over de deelinhoud. Bijvoorbeeld titel: 'Handboek Kantoren Werkinstructies' ondertitel 'Girosparen'.
(Als alle handboeken als een geheel worden gezien zijn alle toevoegingen
over onderdelen en niveaus te zien als ondertitels)
|
|
top /
menu
|
|
3.3 Koppen |
|
|
|
controle koppen
van sjabloon |
De tekst maak je overzichtelijk door goed gebruik van hoofdstuk-, paragraaf- en alineakoppen. Zo vindt
jouw lezer snel het juiste tekstdeel.
Een hoofdstuk verdeel je onder in paragrafen en als die te groot worden in subparagrafen. De alinea is de kleinste eenheid. Op een beeldscherm, waar het overzicht gering is,
lijkt een alinea al snel een paragraafje. Je voorziet hem dan van een kopje.
Waak voor teveel kopjes, dit kan de samenhang van het geheel verstoren. Het is dan beter om trefwoorden of kenwoorden in de linkermarge te
plaatsen, soms een zinsdeel of frase..
Zet geen koppen onder koppen. Vermijd dus een paragraafkop meteen onder een hoofdstukkop.
Zet zo nodig een inleidende zin. (Dit document hanteert deze regel
niet.)
|
|
plaats |
Gebruik de koplayout van het sjabloon.
In Word is dat via het sjabloonmenu Kop 1 t/m Kop 9
|
|
grootte |
Voorbeeld is dit document maar pas het aan aan jouw
bedrijfshuisstijl.
| * |
uitgangspunt is het standaard lettertype
Times New Roman 12pt. |
| * |
de lettergrootte van een Titel is 38 pt en vet |
| |
de lettergrootte van een hoofdstuk-kop is 20pt en vet |
| * |
de lettergrootte van een paragraaf-kop is 16pt en vet
(profiel: kop 2) |
| * |
de lettergrootte van een subparagraaf-kop is 14 en vet
(profiel: kop 3) |
| * |
de lettergrootte van een sub-subparagraaf-kop is 12 en vet
(profiel: kop 4) |
| * |
Als je nog dieper dan koppen wilt zetten ben je
zeker aan het overstructureren. Kijk nog eens goed naar uw indeling.
|
|
|
formulering en stijl
Toelichting tekstformulering in de koppen
|
Koppen kun je op drie manieren formuleren:
* als zelfstandige naamvoorden (kenwoorden, bijvoorbeeld.: Girorekening)
* in werkwoordstijl (bijvoorbeeld: Openen van een girorekening)
* in vraagstijl (bijvoorbeeld: Hoe open ik een girorekening?)
Dit laatste heeft hier niet de voorkeur.
Elke stijl hangt samen met het bedoelde gebruik van het handboek. Gebruik de stijlen dus niet door elkaar. De laatste stijl is echt voor een gebruikershandboek / handleiding en verdient niet de voorkeur.
Gebruik in het aanmaken van koppen een consistente stijl
Koppen zijn voor de eindgebruiker de belangrijkste structuurvormende elementen in het handboek. Met behulp van koppen kan snel en doeltreffend door de teksten worden gescand naar de nodige informatie.
De kop moet de inhoud van de tekst in een of enkele woorden kenbaar maken. Een kop mag niet iets anders dan de inhoud aanduiden.
Bijvoorbeeld 'Derde hoofdstuk handboek kantoren' is een titel die alleen op de structuur slaat en niet de inhoud van het hoofdstuk weergeeft, dit in tegenstelling tot: '3. Girosparen' welke kop de inhoud van het behandelde weergeeft.
P.M. Een afwijkende kop, bijvoorbeeld cursief, wordt gebruikt in uitzonderingssituaties om ergens op te attenderen of voor te waarschuwen. Ze staat buiten de normale structuur van de koppen.
In teksten worden voor benadrukken alleen vette en liever geen cursieve letters gebruikt. Nooit worden letters of woorden onderstreept om te benadrukken, omdat er dan tegenwoordig verwarring ontstaat met linken.
Linken zijn wel onderstreept (onderstreping mag niet worden uitgezet) juist om snel overzichtelijk te houden waar linken in de tekst aanwezig zijn.
Linken op vaste plaatsen daarvoor buiten de tekstalinea's hoeven
daarentegen niet te worden onderstreept.Voor gebruikers gewend aan hypertekst is het gebruik van onderstreping
zonder link buitengewoon frustrerend.
|
|
top /
menu
|
|
3.4 Tekst |
|
|
|
controle sjabloontekst |
Als er al een standaardtekst in het sjabloon staat, controleer dan of die echt van toepassing is. Zo niet voer dan correcties in.
|
|
invoer tekst |
Als je een standaardtekst van elders importeert, controleer dan de lay-out.
Pas zo nodig opnieuw de standaard lay-out toe via het menu (Bij Word cursor in de alinea zetten of een blok over meerdere alinea's trekken en keuzemenu links standaard kiezen).
|
|
lettertype |
Lettertype van dit document is Times Roman 11 punts (kleiner is op scherm moeilijk leesbaar)
De titels beginnen met een kapitaal (hoofdletter)
Als dat bij de
huisstijl van je bedrijf past mag je ook kiezen om de titel met een
kleine letter te beginnen en het standaard lettertypevan de huisstijl
te kiezen. Kies altijd voor slechts 1 standaard lettertype.
|
|
taalgebruik |
Formuleer in korte en bondige volzinnen in actieve stijl. Vermijd consequent oubollige woorden, afkortingen en jargon. Gebruik de spellingscorrector van je tekstverwerker.
|
|
verdeling in alinea's |
Een tekst bouw je altijd op uit alinea's. Iedere paragraaf heeft een hoofdonderwerp dat verdeeld kan worden in sub-onderwerpen. Door per alinea een onderwerp te behandelen is de tekst overzichtelijk.
|
|
geheel van de alinea |
Een alinea is een serie zinnen die een gedachtegang omvat. De kortste alinea is maar 1 zin.
Als je alinea's te lang zijn worden ze moeilijk begrepen. Ze bevatten dan vaak meerdere gedachten achter elkaar of erger: door elkaar. Waar je overgaat op een andere
gedachtegang of instructie maak je een nieuwe alinea.
|
|
splits waar nodig |
Met name in schermteksten moet je heel zorgvuldig en kort formuleren. Is een alinea te lang, dan bekijk je of die niet meerdere
gedachtegangen of instructies bevat. Zo ja, dan splits je de alinea in meerdere alinea's.
|
|
een-, twee- of drie-deling |
| 1 |
De kern van de alinea, datgene waar het om gaat, zet je in een instructief handboek in de eerste zin. In de kortste alinea is dit tevens de hele alinea. |
| 2 |
In de overige zinnen van de alinea werk je dit uit of geef je noodzakelijke toelichting. |
| 3 |
De laatste zin(nen) vormen een uitleiding of overgang en kondigen zo nodig een volgende alinea aan.
|
|
|
kerstbomen |
Let op: Versierende tekst en mooipraterij horen niet in een handboek.
|
|
zelfstandige en aansluitende alinea's |
Het verband tussen de alinea's moet logisch zijn. Met elke alinea beschrijf je bijvoorbeeld een opvolgende stap in een werkproces. Waar een knip in die samenhang zit moet je dat toelichten door een overgangszin aan het eind van de vorige alinea of door een aparte toelichtende (overgangs- slot- of openings-) alinea. (bijvoorbeeld als de behandeling van een produkt via een black box van de ene medewerker naar de ander overgaat.)
|
|
verwijzingen |
Verwijzingen (die, dat etc.) mogen alleen binnen de alinea verwijzen. Waar je verwijst naar items buiten de alinea, noem je die volmondig. Nooit mag je naar koppen verwijzen. Immers koppen zijn alleen een handwijzer voor de structuur maar vormen op zich geen onderdeel van de lopende tekst. Verwijs via volledig schijf en padnamen, volledige documentnamen en zo mogelijk altijd met de
'documentcode'.
|
|
opmaken |
Opmaken hoeft alleen als er geen standaard sjabloon is gebruikt. Zo
nodig werk je de opmaak af bij de eindredactie.
De algemene opmaak in Word is (zolang er geen specifiek sjabloon is) het sjabloon "normaal" in de opmaak galerie.
Dit houdt in:
* lettertype Times Romans
* lettergrootte 11
* regelafstand is 13 punts of standaard van de tekstverwerker
* uitlijning alinea's links, rechts niet uitlijnen
* margeteksten langs de linkerkantlijn plaatsen
* alinea's scheiden door een witregel
* na een paragraaf twee witregels voor de volgende kop
* tussen kop en opvolgende tekst een witregel.
Spring niet in bij het begin van een alinea. Begin binnen een alinea niet op een nieuwe regel, tenzij de tekst het karakter van een opsomming heeft.
Zie paragraaf 'opsommingen'.
|
|
top /
menu
|
|
3.5 Trefwoorden |
|
|
|
plaatsen |
Een trefwoord of ken-frase is een woord of de frase dat de kern van het informatieblok duidelijk maakt.Het
gebruik van trefwoorden bevordert het scannend lezen en het
gestructureert leren. Trefwoorden in de marge is daarom vrijwel
standaard gebruik in leermiddelen. Het trefwoord plaats je
liefst in de marge of kolom links van het informatieblok omdat
wij van links naar rechts lezen..
|
|
stijl |
| * |
Gaat de informatie om een activiteit, kies dan bij voorkeur een werkwoord of frase in werkwoordstijl.
(b.v. 'invoeren gegevens' of 'printen formulier' of 'printen') |
| * |
Gaat het over een zaak, kies dan bijvoorkeur een zelfstandig naamwoord.
(b.v. 'gegevens' of 'formulieren') |
| * |
Gaat het om een eigenschap, kies dan een bijvoeglijk naamwoord. etc.
(b.v. 'legaal' of
|
|
|
tekstopmaak
tabelopmaak
kaders/rasters
witregels
tabelbreedte
|
| * |
Gebruik standaard tekstopmaak. |
| * |
Gebruik een of 3/4 puntslijnen zwart voor echte tabellen. Een lijntje structureert, maar te zwaar
irriteert. |
| * |
Gebruik witte rasters voor tabellen die bedoeld zijn om tekst te lay-outen (zoals deze), omdat wit in 'Word' zowel op het scherm als op papier onzichtbaar is. |
| * |
Plaats een witregel onder een alinea in een lay-outtabel om de cellen visueel te scheiden. In echte tabellen gebeurt dit door de zwarte een of 3/4 puntslijn. |
| * |
Plaats een witregel boven en twee witregels onder de tabel. |
| * |
Houdt waar mogelijk de tabelbreedte binnen het scherm. Waar dit niet mogelijk is, stel je de tekstbreedte boven en onder de tabel opnieuw in tot de standaard lay-outbreedte. |
|
|
top /
menu
|
|
3.6 Tabellen |
|
|
|
Tabellen zijn het meest gebruikte middel om visueel structuur te geven
aan samengevatte informatie. In virtuele documenten zijn tabellen uitzonderlijk geschikt
om pagina's op te maken.
| * |
Maak een tabel zoals dit hoofdstuk(= module) gebruikt is: drie kolommen meerdere rijen |
| * |
De cellen van de bovenste rij voeg je samen voor de titel. |
| * |
De bovenste rij arceer je grijs 20% voor een visuele scheiding van de blokken. |
| * |
In elke rij zet je een kleinste informatie-eenheid het informatieblok, zie sectie Modulair werken. Als het blok toch meerdere onlosmakelijk samenhangende alinea's en daarbij horende trefwoorden bevat, gebruik je meerdere rijen. De trefwoorden en bloktitels blijven zo altijd bij de alinea ook na revisies. |
| * |
De randen en kaders haal je weg, maar je laat de kleur zwart. Je ziet dan stippellijntjes, zodat zichtbaar is in welke cel of je schrijft. |
| * |
Bij de eindredactie worden alle randen en kaders wit, dus onzichtbaar op het scherm, gemaakt. Overigens, dat in Word-tabellen de tabelranden altijd als stippellijntjes zichtbaar blijven is een erfenis uit de tijd dat publicatie alleen voor papier bedoeld was. |
|
|
content |
De content van rijen en kolommen moet worden gelabeld, meestal in de
linker en de bovenste rij. Dit geldt niet als de tabel zuiver bedoeld
is als een layout-tabel.
|
|
echte tabel |
Een voorbeeld van een echte tabel vind je in de
procesbeschrijving van een detailprocesschema als je die in
'Word'opstelt:
* in de bovenste rij de procedurenaam
* in de eerste kolom het stapnummer
* in de tweede kolom de stapnaam
* in de derde kolom de aanvullende informatie.
|
|
lay-out tabel |
In tekstuele opmaaktabellen zoals in dit document zet je:
* in de bovenste rij de modulenaam/titel
* in de eerste kolom niks om wat marge te houden (eventueel nog extra
margekolommen)
* in de tweede kolom de een kenwoord of -frase ten behoeve van het scannend lezen
* in de derde kolom de informatie.
|
|
tabel, figuur of schema |
Tabellen en schema's moet je strikt normeren. Ook figuren moeten
strikt van dezelfde snit zijn. Zo niet dan word je document alsnog een
dwaze kerstboom.
| * |
Tabellen, figuren en schema's voeg je zo nodig paginabreed in door de tabel voor blok-lay-out te splitsen in een deel voor en na de invoeging.
Een voorbeeldtabel is Word-sjabloongalerie: opmaak "klassiek 2". |
| * |
Plaats boven de tabel een witregel en onder de tabel twee witregels.
kolombreedte. Geef de figuur en een kleine illustratieve tabel
een tekstomloop met marge. |
| * |
Geef de tabel of schema een titel rechtsboven en
zo nodig een legenda. Geeft een plaatje een titel onder. |
| * |
De breedte van de kolommen is afhankelijk van de inhoud. In het gebruik is horizontaal scrollen erg
gebruiksonvriendelijk. Vermijdt dus dat de totale breedte van alle kolommen de schermmarges doorbreken. |
| * |
Lijn waar mogelijk de tabel wel over de volle breedte tussen de tekstmarges
uit. Waar een tabel een tekstmarge doorbreekt moeten de tekstmarges boven en onder de tabel zo nodig vastgezet worden, omdat ze anders onbedoeld met de breedte van de tabel fluctueren. |
| * |
Voor tekst in tabellen geldt hetzelfde als bij tekst algemeen,
trefwoorden, trefzinnen en titels of koppen. |
|
|
top /
menu
|
|
3.7 Module lay-out |
|
|
|
|
Een module is een informatie-eenheid.
|
|
lay-out |
Een (tekst)module (zie sectie modulair werken) geef je de lay-out met een tabel als beschreven onder 'tabellen' op de volgende wijze:
|
|
|
|
top /
menu
|
|
|
|
|
3.8 Schema's |
|
|
|
|
|
|
|
soorten |
Voorbeelden van schema's zijn beslissingsschema's, organigrammen en stroomschema's.
|
|
|
|
PM |
De opbouw van veel schema's word dwingend voorgeschreven door het programma waarmee ze gegenereerd worden. Voor wat betreft je eigen afdeling is het van belang goed naar de mogelijkheden van je programma's te kijken.De gebruikers zullen moeten aangeven wat voor hun functioneren de standaard lay-out eisen worden van die schema's.
|
|
|
|
waartoe schema's |
Schema's zijn bedoeld om op snelle wijze iets overzichtelijk te maken. De inhoud moet zo duidelijk mogelijk zijn.
Omdat elk schema gebruikt maakt van al dan niet afgesproken samenvattingen, aanduidingen en symbolen moeten ze bij algemeen gebruik volgens strakke normen gemaakt worden.
|
|
|
|
processchema's |
Ten aanzien van processchema's in bijvoorbeeld SDW geldt:
* altijd 1 processchema per pagina
* geen parallelle proceslijnen op een pagina
* elk proces begint met een trigger
* geen symbolen zonder actieve inhoud of functie toevoegen
* zinvolle (samenhangende inhoud) en hanteerbare mate (overzichtelijkheid) van clustering
in de hoofd en deelprocessen
* elk proces eindigen met een uitvoer naar een database, product of volgend proces.
|
|
|
|
overige schema's |
* Overige schema's PM: hier kunnen in de toekomst standaards voor schema's worden ingevuld.
schema's bij teksten
algemeen:
* Gebruik alleen schema's als dit de tekst verduidelijkt
Laat een schema niet op zichzelf staan. Een toelichting of inleiding hoort er bij.
|
|
|
|
top /
menu
|
|
|
|
3.9 Formulering teksten en instructies |
|
|
|
|
|
|
|
instructieve stijl |
Toelichtingen schrijf je altijd in concrete vlotte, korte en instructieve volzinnen.
In contrast daarmee mag je procesbeschrijvingen ook zo kort mogelijk in begrijpelijke maar korte onvolledige zinnen schrijven. Hanteer hiervoor ook de directe instructieve stijl.
Voorbeeld:
* U opent een spaarrekening.
* openen rekening
* open rekening
* open programma openen rekeningen
* Voer autorisatiecode in.
* Maak fotocopie van paspoort of rijbewijs.
* Vul schermformulier 2.03 , openen rekening, in.
etc.
Niet dus: "Er zal een rekening geopend moeten worden nadat...."
|
|
|
|
top /
menu
|
|
|
|
3.10 Omslag |
|
|
|
|
|
|
|
rug en kaft |
Het omslag sjabloon (voor rug of kaft) vind je op de L schijf/Standaards-richtlijnen.
Op het sjabloon wordt toegevoegd: titel, postcode en versienummers.
|
|
|
|
voorkant |
De voorkant bevat de titel en de auteursnamen. Verder wordt de
voorkant natuurlijk opgeleukt met een smaakmakende afbeelding die het
onderwerp verduidelijkt.
|
|
|
|
top /
menu
|
|
|
|
3.11 Inhoudsopgave |
|
|
|
|
|
inhoud toevoegen met menufunctie |
Ieder handboek of deelhandboek of anderszins zelfstandig onderdeel van het handboek voorzie je van een inhoudsopgave.
Alle hoofdstuk-, paragraaf- en subkoppen neem je op in de inhoudsopgave.
Een inhoudsopgave plaatsen of vernieuwen, doe je veelal geautomatiseerd via de functie /Invoegen/Inhoud/ in de tekstverwerker. Let er daarom op dat je de koppen van koplayout voorziet. Bij Word zet je de cursor op de hoofdstuk of paragraaf kop en klikt daarna in het uitklapmenu links in de menubalk op het juiste kopniveau.
|
|
top /
menu
|
|
3.12 Bronnenlijst |
|
|
|
Bronvermeldigen
lijst |
Waar nodig voor de verantwoording voeg je bronvermeldingen in de tekst.
Bij de bronvermelding is een verwijzing naar een item de bronnenlijst.
Van alle bronvermeldingen wordt een bronnenlijst gemaakt in alfabetische volgorde van de
auteursnaam of in volgorde van verwijzing met oplopende nummering.
|
|
top /
menu
|
|
3.13 Index |
|
|
|
trefwoorden |
De index is een lijst met trefwoorden en de plaats/pagina waar die behandeld worden. Een index is nuttig voor een goede ontsluiting van een omvangrijk naslagwerk. In HTML doe je dit met bladwijzers en linken.
Bij de trefwoorden zet je alle verwijzingen naar alle toepasselijke pagina's of linken naar alle schermen.
De index is een alfabetisch geordende woordenlijst. Met behulp van de index kan de gebruiker vanuit iedere invalshoek de juiste informatie vinden.
De index geef je als titel 'Index' en niet woordenlijst, register e.d.
De index moet (zo mogelijk) volledig en consistent zijn. Maar er mogen in principe alleen woorden in staan die ook werkelijk als vraag bij de gebruiker op kunnen komen. Dit kunnen technische termen bijvoorbeeld software of bankprodukten zijn, maar ook heel gewone woorden zodra die gerelateerd zijn aan bepaalde processtromen, werkinstructie, formulieren
en dergelijke.
Als een term uit meerdere worden bestaat bijvoorbeeld 'optische leesbaar formulier' , zorg dan, dat de gebruiker ook andersom kan zoeken. Bijvoorbeeld onder ' formulier, optisch leesbaar'.
Noem geen termen die de lezer niet verder helpen. Verwijs niet vaker dan nodig naar dezelfde term. Verwijs niet naar plekken die zelf verwijzingen zijn. Kies een 'belangrijkste verwijzing en zet die vet gedrukt vooraan en de overige verwijzingen in volgorde van de inhoud van het handboek.
Laat termen onder elkaar inspringen, als ze bij dezelfde basisterm horen.
|
|
top /
menu
|
|
3.14 Verklarende woorden- en afkortingenlijst |
|
|
|
verklaarde woorden |
De verklarende woordenlijst bevat alle essentiële begrippen. Eigenlijk is het een lijst met verklaarde woorden.
Bij elke term geef je een heldere en eenduidige verklaring. Natuurlijk zonder dat
je opnieuw moeilijke woorden gebruikt.
Ook kan je woorden toevoegen waarvan je vermoed, dat ze voor sommige gebruikers onduidelijke zijn. In ieder geval wordt in elk afzonderlijk te lezen documentdeel elke moeilijke term bij het eerste gebruik zo mogelijk kort verklaard, afkortingen worden in principe niet gebruikt.
Waar afkortingen gebruikt worden als eigennamen van processen of programma's worden de afkortingen bij het eerste gebruik in
het zelfstandig te lezen tekstblok voluit genoemd met tussen haakjes
er achter de afkorting.
De verklarende woordenlijst komt achterin het (Deel)Handboek.
|
|
|
|
3.15 Bijlagen |
|
|
|
zinvolle extra's |
Bijlagen bevatten voorbeeldformulieren, toelichtingen en achtergrondinformatie.
De bijlagen geven geen nieuwe informatie, omdat alle noodzakelijke informatie in het handboek zelf beschreven wordt.
Bijlagen horen altijd bij een verwijzing of een link in de tekst. Je geeft dus niet zomaar een pak bijlagen mee.
|
|
titel |
In de titel van de bijlage zet je altijd het woord bijlage.
Noem de bijlage uitsluitend bijlage, gevolgd door een nummering en een beschrijvende subtitel en niet appendix, voorbeeldformulier
en dergelijke.
|
|
top /
menu
|
|
3.16 Inleidende tekst |
|
|
|
informeren
motiveren |
De inleiding is in onderverdeelde documenten het eerste hoofdstuk en
staat na de inhoudsopgave.
In korte documenten is het de eerste alinea.
De inleidende tekst heeft twee functies:
* je informeert de lezer over onderwerp, doel en gebruik van het document. Je schrijfstijl is dus actief en waar nodig gebiedende wijs.
* je motiveert de lezer om met het document aan de slag te gaan. Je schrijfstijl is dus behalve informerend ook stimulerend.
|
| top /
menu
|
4. Werken met Modules |
|
|
4.1 Modulair werken |
|
|
|
inleiding |
Bedrijfsdocumenten lenen zich voor een hoge graad van normering. Het opbouwen van documenten uit genormeerde onderdelen heet modulair werken. Deze sectie informeert je over wat modulair werken is en hoe je er binnen bijvoorbeeld een afdeling A.O. mee omgaat.
|
|
doel |
Het doel van modulair werken is tweeledig. In de eerste plaats wordt het werk van de afdeling overzichtelijker en effectiever. In de tweede plaats leert de eindgebruiker om snel en effectief de voor hem benodigde informatie te vinden. Het geheel is op termijn buitengewoon kostenbesparend.
|
|
delen |
Vanouds, en dat is nog steeds goed Nederlands, worden lange teksten/documenten ingedeeld in 'delen'.
Delen zijn onafhankelijk te publiceren stukken. Dit kunnen delen zijn die ook onafhankelijk kunnen worden gebruikt of delen die de maximaal te hanteren grootte hebben bereikt.
|
|
modulen en secties |
Delen zijn opgebouwd uit hoofdstukken.
Het kleinste hoofdstuk wordt in sommige methoden wel een module genoemd. Een module is dan een kort genormeerd hoofdstuk over een beperkt afgebakend onderwerp.
|
|
secties |
Een groot hoofdstuk wordt wel verdeeld in subhoofdstukken. Als de subhoofdstukken modules genoemd worden, dan heet zo'n
groot hoofdstuk een "sectie". Een sectie kan natuurlijk ook de vorm hebben van een zelfstandig uitgegeven deel.
Het is dan handig om in een sectie altijd van het eerste hoofdstuk ofwel module een overzichtshoofdstuk te maken.. Bovengenoemde methoden noemen dat dan ludiek een "overzichtsmodule".
|
|
blokken |
Hoofdstukken zijn weer opgedeeld in paragrafen. De kleinste paragraaf omvat tenminste één alinea. In blokken van meerdere alinea's kunnen de alinea's in de linkermarge een trefwoord meekrijgen. Het zijn dan eigenlijk subblokjes.
Waar men spreekt van modules, heten paragrafen "blokken". Deze blokken kunnen tekst, een afbeelding, schema, tabel of zowel tekst als figuren en tabellen bevatten.
Als dat nieuwe van de benaming af is, is ook het 'goeroe effect' weg. Dus laten we voortaan maar spreken van
genormeerde hoofdstukken en paragrafen, of hoofdstukken met met vaste
opbouw. Anderen dan wijzelf begrijpen dan beter wat wij bedoelen.
|
|
top /
menu
|
4.2 Soorten Modulen (=genormeerde hoofdstukjes) |
| |
| Normering van modulen |
Je kunt de opbouw van modulen in blokken op verschillende wijze normeren.
Het verschil wordt bepaald door de aard van de inhoud en het verschil uit zich in het soort blokken dat mag worden opgenomen. De rest van dit blok omvat een aantal suggesties. Eigenlijk is het aan de vakmensen om groepsgewijs een bepaalde norm tot stand te brengen, vast te stellen en te laten evolueren. Bijvoorbeeld voor een GPS, DPS enz.
|
| introductiemodule |
Een introductiemodule (genormeerd introductie hoofdstukje) bouw je
bijvoorbeeld uit de volgende blokken:
* Titel *
* Inleiding
* Doelstelling *
* Overzicht *
* Leesadvies
* Verantwoording *
* Verwijzingen
Titel, doelstelling en overzicht zijn verplichte blokken (paragrafen). De overige zijn facultatief.
|
| proceduremodule |
Een proceduremodule kan bestaan uit de volgende blokken:
* Titel *
* Inleiding
* Toepassing
* Illustratie
* Startpunt
* Instructie *
* Eindpunt
* Vervolg
* Verantwoording
Verwijzing, Titel en instructie zijn verplichte paragrafen. De overige zijn facultatief.
|
| procesmodule |
Een procesmodule bestaat bijvoorbeeld uit de volgende blokken:
* Titel *
* Inleiding
* Definitie
* Startpunt
* Verloop *
* Eindpunt
* Verantwoording
* Verwijzing
Titel en verloop zijn verplichte blokken. De overige zijn facultatief.
|
| structuurmodule |
Een structuurmodule of structuurhoofdstuk bestaat bijvoorbeeld uit de volgende paragrafen:
* Titel *
* Inleiding
* Definitie
* Illustratie *
* Onderdelen
* Opsomming *
* Classificatie *
* Analogie
* Verantwoording
* Verwijzing
Titel, illustratie, onderdelen, opsomming of classificatie zijn verplichte blokken. De overige zijn facultatief.
|
|
top /
menu
|
4.3 Soorten Blokken (=genormeerde paragraafjes) |
| |
| blokken |
De modules zijn opgebouwd uit genormeerde blokken. Het is handig om samen voor de meest voorkomende typen blokken een strikte vormgevingsnorm af te spreken.
|
| Instructieblokken |
Instructieblokken zijn verder te typeren als bijvoorbeeld:
|
| stappenlijst |
In een stappenlijst zijn belangrijk:
* Een stappenlijst begint altijd met een trigger, de aanleiding tot de start en de dwingende volgorde en de afsluiting of output.Dit kan bijvoorbeeld een primaire vraag zijn, maar ook de output uit een ander proces.
* Daarna volgt een lijst van proceshandelingen. In een werkinstructie is dit geformuleerd als instructies (doe dit, doe dat). Zaken die voor een bepaalde handeling al gedaan moeten zijn, moeten ook als eerste worden genoemd.
* Omdat elk proces een doel heeft zal er ook altijd een output zijn. Na en keus is dit: ga naar (stap, vervolgproces)
|
| stappentabel |
Een stappenlijst wordt een stappentabel zodra er een kolom met nummers voor de lijst wordt gezet en eventueel kolommen met namen van betrokken medewerkers
e.d.)
|
| playscript |
Een tabel wordt een playscript als de zichtbare uitkomst van de handeling (bijvoorbeeld de verwachtte beeldschermtekst) in de laatste kolom wordt genoemd, meestal voor de zelfcontrole in een werkinstructie. Strikt genomen is de vorm van een playscript overbodig, maar niet al het personeel is nu eenmaal even goed ingewerkt.
|
| beslissingstabel |
Een beslissingstabel is een item/stappenlijst welke op zich een lijst is van alternatieve handelingen.
In de rechter kolom staat dan bijvoorbeeld de doelvraag van de handeling (bijvoorbeeld, start Exel) en in de kolom rechts er naast hoe (de eigenlijke al dan niet te kiezen handeling).
Voorbeeld: Klik op het exel-icoon in de office werkbalk Eventueel kan in de volgende kolom ook nog het effect van de handeling (playscript; in geval van het voorbeeld, "Op het scherm verschijnt een exel-rekenformulier.") worden toegevoegd. Dit wordt dus een beslissingstabel voor
"dummies"
|
| top /
menu
|
5.1 Samenvatting: |
|
|
|
|
|
|
|
|
| * |
Het handboek is integraal (integrale samenhang en versiebeheer wordt centraal gestuurd met behulp van relationele gegevens te verwerken in een relationele database)
|
| * |
Het handboek richt zich vanuit de producten op de gebruiker (de teksten zijn instruerend en docerend op gebruikersniveau) Dat wil zeggen, de medewerker van het frontoffice respectievelijk backoffice heeft alleen dat deel van de werkinstructie nodig dat voor hem bedoeld is.
|
| * |
Het handboek is modulair en genormeerd opgebouwd. Elk deel is afzonderlijk compleet instruerend en de opbouw van de informatieblokken volgt een vaste orde afhankelijk van het doel.
|
| * |
Het handboek heeft een gestandaardiseerde vormgeving met een uniforme lay-out welke tevens de huisstijl volgt.
|
|
|
|
|
|
|
top
|
|
|
|
|
Inhoud |
Inleiding
1.1 Doel van dit document
1.2 Algemeen
1.3 De inhoud
Stappen bij het maken van documenten
2.1 Kiezen van sjabloon
Invullen van standaardonderdelen in een document
3.1 Kop- en voettekst
3.2 Titel
3.3 Koppen
3.4 Tekst
3.5 Trefwoorden
3.6 Tabellen
3.7 Module layout
3.8 Schema's
|
3.9 Formulering teksten en instructies
3.10 Omslag
3.11 Inhoudsopgave
3.12 Bronnenlijst
3.13 Index
3.14 Verklarende woorden- en afkortingenlijst
3.15 Bijlagen
3.16 Inleidende tekst
Werken met modules
4.1 Modulair werken
4.2 Soorten modulen (=genormeerde hoofdstukjes)
4.3 Soorten blokken (=genormeerde paragraafjes)
Samenvatting van dit document
5.1 Samenvatting
|
|