Hoe gebruikersdocumentatie voor een webstijlgids te schrijven

Stijlgidsen geven de gebruiksregels weer voor de visuele elementen van een merk; Ze worden vaak gebruikt door organisaties die een consistente afbeelding willen behouden tussen inhoud die door veel mensen is gemaakt. Een webstijlgids is vooral belangrijk als uw online-inhoud wordt gemaakt en bewerkt door gebruikers met verschillende vaardigheidsniveaus. Door specifieke regels op te geven voor webpagina's die aan uw organisatie zijn gekoppeld, kunt u ervoor zorgen dat elke pagina een professionele, consistente identiteit promoot. Terwijl u gebruikersdocumentatie voor een stijlgids schrijft, gebruikt u duidelijke, beknopte taal en schrijft u aan gebruikers met de laagste webontwerpvaardigheidsniveaus.

1.

Open de documentatie met een algemene uitleg van de weblay-outs en stijl voor elk type pagina. Hoewel de specifieke paginacategorieën per organisatie kunnen verschillen, kunt u overwegen bestemmingspagina's, titelpagina's, startpagina's, subcategoriepagina's, pagina's met alleen afbeeldingen en alleen tekstpagina's. Gebruik een structuurdiagram om complexe hiërarchieën van informatie uit te leggen en afbeeldingen toe te voegen die voorbeelden van elke lay-out tonen.

2.

Leg uit hoe logo's op verschillende soorten webpagina's kunnen worden gebruikt. Laat gebruikers weten waar ze het logo moeten plaatsen en geef de boven- en ondergrenzen op voor de grootte. Als u meerdere logo-indelingen en kleurvariaties hebt, geeft u de plaatsen op waar ze mogelijk worden gebruikt; alleen het logo gebruiken is mogelijk toegestaan ​​op een pagina die bijvoorbeeld de volledige titel van de organisatie in de titel gebruikt. Neem de logobestanden in uw documentatie op met de afmetingen om het gebruikers gemakkelijk te maken de juiste versie op te slaan. Sluit de tekst met een zin die gebruikers waarschuwt om de kleuren, vorm, grootte of lay-out van uw logo niet te wijzigen om ongeoorloofde bewerkingen te voorkomen.

3.

Maak een lijst van de specifieke lettertypen die moeten worden gebruikt op alle webpagina's van uw organisatie. Neem de lettertypen op voor koppen, subkoppen, titels, hoofdtekst, bijschriften en aanhalingstekens. Geef voor elke categorie de naam van het lettertype op, de grootte en of deze vet, cursief, onderstreept of met een hoofdletter is.

4.

Schrijf over Web-uitzonderingen op de offline stijlgids van de organisatie. Neem elementen op die geen probleem vormen met afdrukmaterialen, zoals hoe u in-tekstkoppelingen presenteert en of externe bronnen aan het einde van een pagina al dan niet worden opgenomen. Als uw groep een meer informele online stijl heeft, legt u aan gebruikers uit hoe u de toon kunt halen bij het schrijven van een webkopie.

5.

Vertel gebruikers welke kleuren ze kunnen gebruiken bij het ontwerpen van pagina's. Geef de kleuren op voor elk type tekst, foto-omtrek, koptekst, navigatiebalk en pagina-scheidingsteken. Geef de specifieke RGB-kleurcodes om de consistentie te waarborgen. Leg gebruikers uit dat kleur een krachtige manier is om uw merkimago te uiten en waarschuw hen om alleen de aangegeven kleuren te gebruiken om de algehele gebruikerservaring te behouden.

6.

Leg de regels voor het gebruik van foto's vast op webpagina's van organisaties. Als al uw pagina's een specifiek ontwerp hebben, legt u uit waar gebruikers foto's kunnen plaatsen. Maak een lijst van de vereiste pixelafmetingen voor verschillende toepassingen: in-tekst foto's, kop foto's of sidebar foto's, bijvoorbeeld. Om de website gemakkelijker te laden te maken, geeft u specifieke afbeeldingsresoluties op. Voor het web is 72 dpi de standaard. Laat gebruikers de afbeeldingen bijsnijden, vergroten / verkleinen en bewerken voordat ze in de website worden geplaatst om de snelheid te optimaliseren.

7.

Sluit de documentatie door de vereiste verklaring of ontwerpelementen uit te leggen die op elk type pagina moeten staan. Neem items op zoals gelijkekansen-tewerkstellingsverklaringen en auteursrechtvermeldingen en laat gebruikers de exacte plaatsing op de pagina weten. Als u een afbeelding of afbeelding hebt die op de pagina moet verschijnen, vermeldt u de vereisten voor plaatsing en verstrekt u het bestand voor onmiddellijke download.