Ontwikkelen handleiding templates

Manualise ontwikkelt templates: De basis voor al uw technische documentatie

    In een template (ook wel sjabloon genoemd) komen alle beslissingen samen over de grafische vormgeving van uw handleiding. Voor printversies zijn dit de zogenaamde stijlen en het ontwerp voor de paginalayout. Voor de online versies op het web zijn dit de masterpage en de ‘skin’.

    In een template kunt u ook de inhoudsopgave vastleggen, met daarin de altijd of vaak voorkomende hoofdstukken.

    Vraag direct een offerte aan →

    Stijlen

    Een template beschrijft de zogenaamde ‘stijlen’. Stijlen bevatten lettertypen, lettergroottes enzovoort. Een lettertype definieert een verzameling lettertekens die qua vorm een eenheid vormen. Arial en Times zijn bijvoorbeeld veelgebruikte lettertypen. In het bedrijfsleven maken lettertypen vaak deel uit van de corporate identity.

    Er zijn lettertypen met schreef en zonder schreef. Bij een type met schreef lopen de uiteinden van de letters een beetje uit, ze ‘krullen’ iets. Is dit niet het geval, dan spreken we van een schreefloos lettertype.

    • Een rustig lettertype met schreef is doorgaans geschikt voor een lopende tekst op papier. Soms kan schreefloos op papier echter ook.
    • Online lettertypen zijn schreefloos, dit leest beter op een scherm.

    De lettergrootte is ook van belang. De grootte van de letters hangt sterk af van de doelgroep: oudere mensen hebben in het algemeen een voorkeur voor een grotere letter dan het doorsneeformaat van 11 of 12. De Europese richtlijn IEC 82079-1 schrijft een lettergrootte voor van minimaal 10. Er zijn echter ook productspecifieke normen die bij waarschuwingen een letterhoogte voorschrijven van minimaal 4 mm.

    Ieder lettertype kent ook zijn varianten, bijvoorbeeld italic of bold. Bij specifieke omschrijvingen op een apparaat of in een softwarepakket is een aanduiding in bold (vet) vaak gebruikelijk. Voorbeelden zijn “Druk op de Start-knop” (van een apparaat) of “Klik op Annuleren” (in een softwarepakket).

    Ten slotte zijn kenmerken voor de tekstregels van belang. Welke regelafstand is gewenst, welke regellengte? Is het een goed idee uit te lijnen zodat alle tekstregels even lang zijn?

    shopify
    Voorbeeld van een tabel met typische stijl
    H1.2_Manualise_Toon_assembly_exploded_view
    Voorbeeld van een illustratie met typische stijl
    Wat legt een template vast?
    •  Tekstmarges
    •  Indeling met tussenkoppen
    •  Lettertype(n)
    •  Tabelgrootte en -stijl
    •  Illustratievoorschriften (de kleur en de vorm van pijlen bijvoorbeeld)
    •  Webskin (de steeds terugkerende elementen op elke webpagina)
    •  Inhoudsopgave met een bepaalde hoofdstukkenstructuur
    •  Huisstijlelementen (zoals het logo)
    •  Wettelijke verplichtingen (zoals waarschuwingssymbolen)

    Indeling pagina

    De indeling van een pagina bestaat uit (per hoofdstuk):

    • een hoofdkop (ook wel: titel)
    • een inleiding (ook introtekst genoemd) in de eerste alinea
    • tussenkoppen (ook wel: subtitels) per paragraaf
    • de teksten in de paragrafen

    Daarbij is het van belang het eerst eens te worden over het formaat van de pagina. Wordt dat A4 of A5? A4 geeft meer ruimte om grote afbeeldingen af te drukken. A5 is lekker handzaam. Steeds kan de afweging anders zijn.

    Eneco_instructie_brochures_A5-01

    Thuis in alle software

    Er zijn drie hoofdgroepen software waarmee een vormgever stijlen kan vastleggen.

    • Tekstverwerkers
    • Opmaakprogramma’s (ook wel: DTP-programma’s)
    • Contentmanagementsoftware

    ‘Gewone’ tekstverwerkers, zoals MS Word, bieden redelijk wat mogelijkheden voor het opmaken van documenten. Een voordeel van tekstverwerkers is dat vrijwel iedereen vertrouwd met ze is. Bovendien gaan schrijven en opmaken in tekstverwerkers vaak hand-in-hand. Dat is efficiënt.

    Opmaakprogramma’s zoals Adobe InDesign (ook wel desktoppublishing- of DTP-programma’s genoemd) leveren drukwerk van uitermate hoge kwaliteit. De opmaakmogelijkheden van desktoppublishing-programma’s zijn nagenoeg onbeperkt. Import van bestaande tekstverwerkersbestanden met behoud van opmaakeigenschappen is mogelijk.

    Ook contentmanagementsoftware, zoals MadCap Flare, kent tegenwoordig allerlei opmaakmogelijkheden, inclusief de import van bestaande opmaakkenmerken uit tekstverwerkers. Contentmanagementsoftware zorgt er vervolgens voor dat alle relevante informatie op een centrale plek terechtkomt, als broninhoud voor alle toekomstige print- en online uitgaven.

    Wat kunnen wij voor u betekenen?

    Wij ontwikkelen voor u de templates die u wenst. Wij definiëren de structuur en de stijlen. Hierbij houden we rekening met de CE-regelgeving.

    De templates kunnen we opslaan in vrijwel alle bestandstypen. Met andere woorden: u kunt er naderhand desgewenst zelf mee aan de slag.