Gisteren ben ik gevraagd om een deel van onze kennisbank te herschrijven. Fantastisch, na de broncode nu ook de inhoud!
Blijkt dat er enkel een handleiding bestaat voor de editors en de authors. Geen stijlgids voor de inhoud; met alle nodige gevolgen.
Eén blik op de troubleshooting sectie van de website maakt al snel duidelijk dat er geen standaard is. Iedereen rommelt maar wat aan; foutmeldingen worden steeds op een andere manier weergegeven, punctuatie bestaat niet en een algemene opbouw van de informatie is ver zoek.
De pagina met de woordenlijst (glossary) wordt niet onderhouden. De pagina is leeg.
Andere teams onderhouden de pagina wel en gebruiken een dode URL om de locatie van de belangrijkste pagina aan te duiden. Vreemd maar waar. Het wordt niet toegelaten om de link actief te maken.
Een stijlgids en een woordenlijst zal ik zelf moeten aanmaken.
Al vast enkele interessante links:
- De EServer Technical Communication Library is echt een gigantische informatiebron over technish schrijven, webdesign, usability en knowledge management. In de database vind je artikels over het onderwerp, blogs en portaalsites.
- De stijlgids van Apple staat er ook tussen. Het hoofdstuk “How to write a glossary” heeft veel duidelijk gemaakt.