Bokrecension: Microsoft Manual of Style, 4: e upplagan

Oavsett om du skriver en blogg, en bok, en webbplats eller texten för ett programs användargränssnitt, mer konsekvent du är tydligare saker kommer att bli. Det är lättare när man har en stilguide, så att du inte behöver avgöra varje gång om det är “webbplats”, “hemsida” eller “hemsida” och om att säga “logga in” eller “logga på” (logga in är bättre, om du pratar om enkel inloggning på och få tillgång till flera tjänster av företag med en inloggning).

Rörlighet, Hands-on med en Samsung Galaxy S7 Edge på Republic Wireless: En bättre Wi-Fi-samtal erfarenhet, först ta: En tuff Android tablett för krävande miljöer, rörlighet, Hands-on med Plantronics Backbeat GO 3 och Voyager 5200 headset: perfekt för den nya Apple iPhone

Ungefär hälften av den nya upplagan av Microsoft Manual of Style är en omfattande stilguide som täcker allt från att hänvisa till “piltangenterna” i stället för “pilknapparna” som att säga “zooma ut” snarare än “Zooma ut”. Den uppdaterar och utvidgar tidigare upplagor avsevärt (de är långt smalare volymer), tillsätta nya termer som NUI (Natural User Interface – med hjälp av röst, beröring och gester för att styra en dator, som påpekat är en klumpig term flesta människor vann ” t förstår så du bör förklara det i stället) samt slutligen acceptera att e-post inte längre har ett bindestreck.

Microsoft är naturligtvis experten på rätt namngivning av SQL Server och delar av Windows-gränssnittet (området bredvid Windows-klockan är meddelandefältet, inte systemfältet, till exempel). På mer allmänna termer kan du inte håller med om varenda stil val i guiden (är några människor fortfarande avstavning e-bok och e-handel till exempel, så vi definitivt inte håller med Microsoft Manual där), men alternativen är avsiktligt märkta som vara i Microsoft stil eller inte snarare än att vara rätt och fel.

Totalt är det en omfattande guide som ger dig en bra startpunkt – och i de flesta fall är det svårt att argumentera med. Banning portmanteau ord som “weblication” och veta när man ska använda “backup” och “back up”, men att man alltid skriva offline som ett enda ord kommer att förbättra någon del av teknisk dokumentation. Säger laptop snarare än bärbara dator kan tyckas lite pedantisk, men med den här listan på cirka 1000 beslut stil innebär att du kan tänka på hur konsekvent du vill vara. Om du tror att säga anteckningsbok är bra, göra en anteckning och du kan använda detta som starten på din egen stilguide.

Den andra halvan av boken är en stil manuella i en mycket bredare bemärkelse. Det börjar med en utmärkt förklaring till varför ha en konsekvent stil och röst är så bra på teknisk dokumentation och gränssnitt. Återigen, du förmodligen inte kommer att anta Microsoft stil grossist, men om du vill ha en tydlig stil för att kommunicera, principer som man undviker alltför många frågor, utropstecken och vardagsuttryck är ett bra ställe att börja. Det är uppfriskande att se avsnitten om att undvika stereotyper om ras, kön och handikapp (alldeles för mycket tekniska skribenter övertar alla läsare är vita, manliga och inte långt från college). Råden för att undvika anthropomorphising datorer kommer att göra en tydligare skrivning också – en taligenkänningsmotor inte “vet” något ord, och tyder på att den gör är vilseledande.

Om du granskar programvara, skriva manualer eller skapa ett användargränssnitt, kapitlen om hur man skriver och dialog dokument rutor och kommandon är fulla av användbara checklistor och tabeller om allt från rätt namn för olika kontroller till hur man refererar till filformat . Avsnittet om terminologi för cloud computing är så klart det fungerar som en praktisk sammanfattning av moln teknik (utan någon bias mot Microsoft-tjänster antingen). Den uttömmande täckning av hur du formaterar siffror korrekt kan tyckas överdrivet, tills du försöker att vara konsekvent i en 300-sidigt dokument när du ska vara glad för dem. Det finns förslag på stilar för bildtexter, bibliografier, telefonnummer, index och andra saker som är bättre när de är förenliga. Avsnitten om interpunktion och grammatik är tydliga och bra utan att vara pedantisk om saker som när passiv kan användas. Sexton sidor förkortningar och mätningar (det är YB och ZB för YOTTABYTE och ZETTABYTE, till exempel) kommer att spara en hel del argument också.

I avsnittet om att skriva för webben är också till hjälp, med tips om hur man organiserar innehåll, vad som gör en bra video, när en wiki är en bra metod för gemenskap innehåll och grunderna i både sökmotoroptimering och sociala medier marknadsföring. Återigen, det är bra att se riktlinjer för att göra innehåll tillgängligt, det täcker inte allt du behöver veta, men du får grunderna för att organisera innehåll så att det fungerar med en skärmläsare och vad som är problematiskt för färgblinda läsare (och noterar om korrekt formatering för skärmläsare visas överallt där det är relevant, inte bara i ett avsnitt som du kanske vända förbi bråttom). Detta är en omfattande guide till god teknisk dokumentation som får dig att tänka om att kommunicera samt att få din kapitalisering rätt, även om du aldrig använda en enda Microsoft-produkt.

Microsoft Manual of Style, 4: e upplagan, Elizabeth Whitmire, Microsoft Press, 464 sidor, ISBN 9780735648715, £ 22.99

mary Branscombe

Hands-on med en Samsung Galaxy S7 Edge på Republic Wireless: En bättre Wi-Fi-samtal erfarenhet

Microsoft pigg, först ta: Skapa engagerande innehåll på din smartphone

Xplore Xslate D10, först ta: En tuff Android tablett för krävande miljöer

Hands-on med Plantronics Backbeat GO 3 och Voyager 5200 headset: Perfekt för den nya Apple iPhone