Sådan skrives brugerdokumentation til en webstylguide

Stilguider fastsætter bruksreglerne for de visuelle elementer i et mærke; de er almindeligt anvendt af organisationer, der ønsker at holde et konsekvent billede på tværs af indhold, der er skabt af mange mennesker. En webstilguide er særlig vigtig, hvis dit onlineindhold oprettes og redigeres af brugere med varierende færdighedsniveauer. Ved at fastsætte specifikke regler for websider, der er knyttet til din organisation, kan du hjælpe med at sikre, at hver side fremmer en professionel, ensartet identitet. Når du skriver brugerdokumentation for en stilguide, skal du bruge klart, kortfattet sprog og skrive til brugerne med de laveste webdesign færdighedsniveauer.

1.

Åbn dokumentationen med en samlet forklaring på weblayouterne og stilen for hver type side. Selv om de specifikke sidekategorier vil variere efter organisation, overveje landingssider, titelsider, hjemmesider, underkategori sider, kun billeder og kun sider med kun tekst. Brug et strukturdiagram til at forklare komplekse hierarkier af information og inkludere grafik, der viser eksempler på hvert layout.

2.

Forklar, hvordan logoer kan bruges på forskellige typer websider. Lad brugerne vide, hvor de skal placere logoet, og list de øverste og nederste grænser for størrelse. Hvis du har flere logo layouter og farvevariationer, skal du angive de steder, de kan bruges til; Brug af logoet alene kan være tilladt på en side, der f.eks. bruger organisationens fulde titel i titlen. Medtag logo-filerne i din dokumentation med dimensionerne, så det bliver nemt for brugerne at gemme den rigtige version. Luk teksten med en sætning, der advarer brugere om ikke at ændre farver, form, størrelse eller layout på dit logo for at forhindre uautoriserede redigeringer.

3.

Skriv de specifikke skrifttyper, der skal bruges på alle organisationens websider. Medtag skrifttyperne for overskrifter, underpositioner, titler, tekst, tekst og citater. For hver kategori skal du skrive skrifttypens navn, størrelse og om det er fed, kursiv, understreget eller aktiveret.

4.

Skriv om web undtagelser til organisationens offline stil guide. Inkluder elementer, der ikke er et problem med udskriftsmateriale, f.eks. Hvordan du præsenterer links i teksten eller om du vil inkludere eksterne kilder i slutningen af ​​en side eller ej. Hvis din gruppe har en mere uformel online-stil, skal du forklare brugerne, hvordan du opnår tonen, når du skriver webkopi.

5.

Fortæl brugerne, hvilke farver de kan bruge, når de designer sider. Angiv farverne for hver type tekst, fotooversigt, overskrift, navigeringslinje og sideseparator. Giv de specifikke RGB-farvekoder for at sikre konsistens. Forklar for brugerne, at farve er en kraftfuld måde at udtrykke dit brandbillede på og vær forsigtig med at bruge kun de angivne farver for at bevare den samlede brugeroplevelse.

6.

Udsæt reglerne for foto brug på organisationens websider. Hvis alle dine sider har et bestemt design, skal du forklare, hvor brugere kan placere fotos. Angiv de pixeldimensioner, der kræves til forskellige anvendelser: f.eks. I-tekst-fotos, header-fotos eller sidebilleder. For at gøre hjemmesiden lettere at indlæse, giv specifikke billedopløsninger - for internettet er 72 dpi standard. Fortæl brugerne at beskære, ændre størrelse og redigere billederne, før de placeres på hjemmesiden for at optimere hastigheden.

7.

Luk dokumentationen ved at forklare den krævede erklæring eller designelementer, der skal være på hver type side. Inkluder varer som lige muligheder ansættelseserklæringer og ophavsret meddelelser og lad brugerne vide den nøjagtige placering på siden. Hvis du har en grafik eller et billede, der skal vises på siden, skal du angive placeringskravene og give filen til øjeblikkelig download.