Så här skriver du användardokumentation för en webbstylguide

Stilguider definierar användningsreglerna för ett visuellt element i ett varumärke; De brukar användas av organisationer som vill hålla en konsekvent bild över innehåll som skapas av många människor. En webbstylguide är särskilt viktig om ditt onlineinnehåll skapas och redigeras av användare med olika kompetensnivåer. Genom att ange specifika regler för webbsidor som är associerade med din organisation kan du hjälpa till att säkerställa att varje sida främjar en professionell, konsekvent identitet. När du skriver användarhandlingar för en stilguide använder du tydligt, kortfattat språk och skriver till användarna med de lägsta nivåerna på webbdesign.

1.

Öppna dokumentationen med en övergripande förklaring av webblayouterna och stilen för varje typ av sida. Även om de specifika sidokategorierna varierar beroende på organisation, bör du överväga målsidor, titelsidor, hemsidor, underkategori sidor, bildsidiga sidor och sidor som endast innehåller text. Använd ett strukturdiagram för att förklara komplexa hierarkier med information och inkludera grafik som visar exempel på varje layout.

2.

Förklara hur logotyper kan användas på olika typer av webbsidor. Låt användarna veta var de ska placera logotypen och lista de övre och nedre gränserna för storlek. Om du har flera logotyplayouter och färgvarianter, lista de platser de kan användas. Användning av logotypen ensam kan vara tillåten på en sida som använder organisationens fullständiga titel i titeln, till exempel. Inkludera logotypfilerna i dokumentationen med måtten för att göra det enkelt för användare att spara rätt version. Stäng texten med en mening som varnar användarna om att inte ändra din logotyps färger, form, storlek eller layout för att förhindra obehöriga ändringar.

3.

Ange de specifika typsnitt som måste användas på alla organisationens webbsidor. Inkludera teckensnitt för rubriker, underrubriker, titlar, text, text och citat. För varje kategori lägger du ut teckensnittsnamnet, storleken och om den är fet, kursiv, understruken eller aktiverad.

4.

Skriv om webb undantag till organisationens offline stil guide. Inkludera element som inte är ett problem med utskriftsmaterial, till exempel hur man presenterar textlänkar eller huruvida externa källor ska inkluderas i slutet av en sida. Om din grupp har en mer informell online-stil, förklara för användarna hur du uppnår tonen när du skriver webbkopia.

5.

Berätta för användarna vilka färger de kan använda vid utformning av sidor. Ange färgerna för varje typ av text, bildvy, rubrik, navigeringsfält och sidavskiljare. Ge de specifika RGB-färgkoderna för att säkerställa konsistens. Förklara för användaren att färgen är ett kraftfullt sätt att uttrycka din varumärkesbild och varna dem för att bara använda de angivna färgerna för att bevara den övergripande användarupplevelsen.

6.

Lägg ut reglerna för fotoanvändning på organisationswebbsidor. Om alla dina sidor har en specifik design, förklara var användarna kan placera foton. Ange de pixeldimensioner som krävs för olika användningsområden: In-text-bilder, bildfotografier eller sidobilder, till exempel. För att göra webbplatsen enklare att ladda, ge specifika bildresolutioner - för webben är 72 dpi standard. Berätta för användare att beskära, ändra storlek och redigera bilderna innan de placeras på webbplatsen för att optimera hastigheten.

7.

Stäng dokumentationen genom att förklara de nödvändiga uppgifterna eller designelementen som måste vara på varje typ av sida. Inkludera saker som anställningsannonser med lika möjligheter och upphovsrättsmeddelanden och låta användarna veta exakt placering på sidan. Om du har en grafik eller bild som ska visas på sidan, lista placeringskraven och lämna filen för omedelbar nedladdning.