Technische communicatie of documentatie is het proces van het overdragen van "gebruiksvriendelijke" informatie via schrijven over een bepaald onderwerp aan een doelgroep. Technische documentatie varieert van een zakelijke e-mail tot zakelijke rapporten naar een gebruiker leiden of help-systeem. Veel Schakel alleen documentatie "wanneer al het andere faalt." Geen wonder dat documentatie is vaak nagemaakte hoogstens; niet-bestaand op erger. Computerbedrijven kunnen voelen dat hun software is zo eenvoudig, ze hoeft niet documentatie. Maar technische documentatie is minder duur dan technische ondersteuningsvragen. Voordat u goede technische documentatie ontwikkelen kan, moet u weten dat doeltreffende technische documentatie een goed geplande en uitgevoerde missie is.
Wat die u nodig hebt
- Computer
- Ontwerpgereedschap
- Onderwerp deskundige
Bepalen van doel en doelgroep. U wilt weten waarom u deze documentatie maakt en die zal lezen. Welke documentatie u zal anders als je publiek een automonteur is dan als doelpubliek een softwareingenieur is zijn.
Informatie verzamelen. De persoon die maakt de documentatie is vaak een schrijver en niet het onderwerp expert. Het is belangrijk te verzamelen van de informatie, zodat u het documenten kunt. Verzamelen van de informatie kan betekenen voor het doen van onderzoek, interviewen van een expert of experimenteren met het product zelf, zoals in het geval van een softwareprogramma.
Organiseren en overzicht van de informatie. U kunt beginnen met een bestaand document of een sjabloon. Het is belangrijk dat u welke gegevens u hebt en laat de lege gebieden waar u moet om meer informatie te verzamelen. Dit zal uw werkdocument, en u zal voortbouwen op het. Noteren van wat u hebt, zelfs als u over grote gebieden van lege ruimte zal uw vertrouwen die u naar voren in het project verplaatst.
Het eerste ontwerp te schrijven. Dit is wanneer u de lege cellen invullen en rekening houdend met een stroom van ideeën voor het streamen van je bewustzijn. Stop die stroom niet door een herziening van dit stadium.
Herzien en bewerken. U kunt het document om weg te zetten voor een periode van tijd zodat kunt u het een frisse blik geven. Dan richten op onderwerpen die meer aandacht te besteden moeten; verkorten, uitbreiden of verwijderen van secties; of de volgorde van de alinea's, zinnen of hele onderwerpen. U zult ook willen bewerken voor stijl, grammatica en context.
- Een editing controlelijst is handig zodat u voor verschillende punten bij de aparte passeert bewerken kunt.
- Het ontwikkelen van goede teamplayer vaardigheden en een goed begrip van hoe elke onderwerp deskundige geeft de voorkeur aan te werken om te voorkomen dat deze relatie steeds hoor en wederhoor.
