Vijf tips voor het schrijven van grote technische documentatie

Het maken van technische documentatie maakt deel uit van het doen van werk in de IT-industrie. Technische handleidingen, technische instructies specificatie, ondersteuning gidsen, implementatie handleidingen - elk zijn vormen van technische documentatie en zijn een deel van de baan. Een veel technische functies in de IT-industrie deel te nemen in de documentatie proces. Het zou alleen maar lijkt eenvoudig om zomaar wat woorden en diagrammen samen een inhoudsopgave en denk aan het als een technisch document, maar het &'; s een beetje meer dan dat. I &'; ve vijf tips hieronder over hoe om grote technische documenten schrijven

Met een goed gestructureerde Inhoudsopgave

De inhoudsopgave is een van de meest belangrijke deel van een document.. De inhoudsopgave laat zien wat in feite in het document en hoe het wordt geregeld. Het wordt gebruikt om gebruikers te helpen begrijpen dat het document bevat de informatie die ze zoeken. Het onderzoeken van de inhoudsopgave, zijn ze in staat om gemakkelijk te zien of het heeft wat ze nodig hebben, of als ze nodig hebben om een ​​document te lezen.

Een bijkomend voordeel van het hebben van een goed gestructureerde inhoudsopgave wordt het mogelijk de lezer om de informatie die ze nodig hebben snel te vinden. Microsoft Word, Adobe PDF en ook andere documenten toepassingen kunt aanklikbare links van de inhoudsopgave. Zo kunt u op het item of het paginanummer en het zal u naar die pagina. . Zeer nuttig voor het vinden van onderwerpen snel

Wees beknopte maar grondige

Omdat het een technisch document auteur, it &'; s moeilijk om echt te weten welke hoeveelheid en wat voor soort informatie in dit document te zetten. Om een ​​groot document te schrijven, probeer korte, maar grondig te zijn. Wat dit betekent is niet te gaan en op en in allerlei details over bepaalde gebieden die niet nodig zijn door de lezer. Het is niet gemakkelijk om wat en ' vertellen; s relevant is en wat isn &'; t -, maar een poging om de lezer en de doelgroep te overwegen wanneer u &'; re schrijven van het document. Als je te “ langdradig &"; of te veel informatie waar het &' gebruiken; s niet nodig, zal het uitschakelen van de lezers en het won &';. t een effectieve document

Wees consistent in het hele document

Consistentie is een belangrijke manier om een document te verbeteren. Het maakt het kijken meer professionele, en in feite beter leesbaar voor de gebruiker. Toen ik consistentie zeggen, ik bedoel regelmaat zowel in het jargon dat u gebruikt en de opmaak toepassen. Sommige individuen won &'; t dit merken. Niettemin, als u &'; re een technisch document componeren, it &'; s meer dan waarschijnlijk voor andere technische gebruikers, die meestal-detail gericht mensen. Zorg ervoor dat uw document gebruikt dezelfde opmaak in. Probeer om de gegevens te breken en maken het begrijpelijk is voor de gebruikers door gebruik te maken van de witte ruimte effectief.

Met gebruik van dezelfde uitdrukking wordt ook aanbevolen. Dit zal waarschijnlijk ervoor zorgen dat de gebruiker weet dat je &'; re schrijven over hetzelfde met dezelfde woorden. Als je door elkaar te gebruiken woorden, bijvoorbeeld “ desktop &" ;, “ PC &" ;, “ computer &" ;, dat zou kunnen verwarren de gebruiker, wanneer u eigenlijk hetzelfde. Dat &'; sa snel voorbeeld, maar het idee is dat je de ene term moet kiezen en blijf erbij

Houd deze juist en fout-Free

Het spreekt bijna vanzelf dat de technische documentatie echt. moet worden foutloos. Zoals ik hierboven vermeld, zal een flink aantal lezers van het document andere technische gebruikers, en er &'; s een vrij goede kans de fouten zal opvallen aan hen. In aanvulling op dat, als de fouten don &'; t eruit springen, dan biedt hen de verkeerde informatie met betrekking tot het systeem of het gebied dat u &'; Re documenteren - dat het doel van het document verslaat

Vermijd groot scherm vangt

Door gebruik te maken van schermafbeeldingen of screenshots binnen uw documentatie is zeker een effectieve manier uit te leggen je punt aan de lezer. It &'; s in de eerste plaats nuttig voor software-documentatie of ondersteunende processen, die gemakkelijk te nemen screenshots van zijn. Echter, computerschermen gekregen groter de jaren, maar A4 vellen steeds even groot zijn.

Dit laat een neiging om grote schermafbeeldingen nemen in een document dat de schermafbeeldingen kleine ineffectief maakt. Inclusief screenshots is een geweldig idee - don &'; t me niet verkeerd - maar een inspanning leveren om alleen de gebieden die gerelateerd zijn aan het gedeelte dat u &'; re verklaren. Dit heeft de neiging om te leiden tot meer screenshots, maar ze zullen effectiever
  zijn en maken het document meer leesbaar.;