Hvordan skrive brukerdokumentasjon for en webstyleguide

Stilguider legger ut bruksreglene for de visuelle elementene til et merke; De blir ofte brukt av organisasjoner som ønsker å holde et konsistent bilde på tvers av innhold som er opprettet av mange mennesker. En webstyleguide er spesielt viktig hvis innholdet ditt på nettet er opprettet og redigert av brukere med varierende ferdighetsnivå. Ved å angi spesifikke regler for websider som er knyttet til organisasjonen din, kan du bidra til at hver side vil fremme en profesjonell og konsistent identitet. Når du skriver brukerdokumentasjon for en stilguide, bruker du klart, kortfattet språk og skriver til brukerne med de laveste nivåene på webdesign.

1.

Åpne dokumentasjonen med en samlet forklaring på weboppsettene og stilen for hver type side. Selv om de spesifikke sidekategoriene vil variere etter organisasjon, bør du vurdere destinasjonssider, tittelsider, hjemmesider, underkategori sider, kun bildesider og bare tekstsider. Bruk et strukturdiagram for å forklare komplekse hierarkier med informasjon og inkludere grafikk som viser eksempler på hvert layout.

2.

Forklar hvordan logoer kan brukes på ulike typer websider. La brukerne vite hvor de skal plassere logoen og oppgi øvre og nedre grenser for størrelse. Hvis du har flere logooppsett og fargevarianter, oppgi de stedene de kan brukes til; Bruk av logoet alene kan være tillatt på en side som bruker hele organisasjonens tittel i tittelen, for eksempel. Ta med logo-filene i dokumentasjonen med dimensjonene for å gjøre det enkelt for brukerne å lagre den riktige versjonen. Lukk teksten med en setning som advarer brukere om ikke å endre farger, form, størrelse eller layout på logoen din for å forhindre uautoriserte endringer.

3.

Oppgi de spesifikke skriftene som må brukes på alle organisasjonens nettsider. Inkluder fonter for overskrifter, undertitler, titler, tekst, tekst og anførselstegn. For hver kategori legger du ut skriftnavn, størrelse og om det er fet, kursiv, understreket eller aktivert.

4.

Skriv om web unntak til organisasjonens offline stil guide. Inkluder elementer som ikke er et problem med utskriftsmateriale, for eksempel hvordan du presenterer teksttekstledninger eller om du vil inkludere eksterne kilder på slutten av en side. Hvis gruppen din har en mer uformell online stil, forklarer brukerne hvordan du får tonen når du skriver webkopi.

5.

Fortell brukere hvilke farger de kan bruke når du designer sider. Oppgi fargene for hver type tekst, bildeoversikt, topptekst, navigeringslinje og sideseparator. Gi de spesifikke RGB-fargekodene for å sikre konsistens. Forklar brukerne at fargen er en kraftig måte å uttrykke ditt merkebilde på og vær forsiktig med at de bare bruker de angitte farger for å bevare den generelle brukeropplevelsen.

6.

Legg ut reglene for bruk av foto på organisasjonens websider. Hvis alle sidene dine har et bestemt design, forklar hvor brukerne kan plassere bilder. Oppfør pikselmåttene som kreves for forskjellige bruksområder: In-text-bilder, for eksempel bilder i topptekst eller sidebar, for eksempel. For å gjøre nettstedet enklere å laste inn, gi spesifikke bildeoppløsninger - for Internett er 72 dpi standard. Fortell brukerne å beskjære, endre størrelse og redigere bildene før de plasseres på nettstedet for å optimalisere hastigheten.

7.

Lukk dokumentasjonen ved å forklare den nødvendige setningen eller designelementene som må være på hver type side. Inkluder elementer som ansettelseserklæringer om opphavsrett og opphavsrettserklæringer og la brukerne vite nøyaktig plassering på siden. Hvis du har en grafikk eller et bilde som skal vises på siden, må du oppgi plasseringskravene og gi filen for umiddelbar nedlasting.