Viisi Vinkkejä kirjoittaminen Iso Tekninen Documentation

luominen tekninen dokumentaatio on osa tekee työtä IT-alalla. Tekniset käsikirjat, teknisten spesifikaatioiden ohjeet, tukioppaat, täytäntöönpano käsikirjat - kukin ovat eri teknisten asiakirjojen ja ovat osa työtä. Paljon teknisiä rooleja IT-alan osallistuvat dokumentointiprosessin. Se voi vain tuntua suoraviivaista vain laittaa sanoja ja kaavioita yhdessä, sisällysluettelo ja ajatella sitä teknisen asiakirjan, mutta se &todellisten tuloste; sa hieman enemmän. I &'; ve lueteltu viisi vinkkejä alla siitä, miten kirjoittaa suuri tech docs.

Käytä hyvin jäsennelty Sisällysluettelo

sisällysluettelo on yksi tärkeimmistä osa asiakirjan. Sisällysluettelo luetellaan mitä on itse asiassa ohjeesta ja se on järjestetty. Sitä käytetään auttaa käyttäjiä ymmärtämään, että asiakirjassa annetaan tietoa he etsivät. Tutkitaan sisällysluettelo, he pystyvät helposti nähdä, jos se on mitä he tarvitsevat, tai jos ne täytyy lukea toiseen asiakirjaan.

lisäetu ottaa hyvin jäsennelty sisällysluettelo on se mahdollistaa lukija löytää tarvitsemansa tiedot nopeasti. Microsoft Word, Adobe PDF- ja myös muut asiakirjat sovelluksia sallivat linkkejä, on sisällysluettelo. Näin voit klikkaa kohde tai sivunumero ja se vie sinut kyseiselle sivulle. Erittäin hyödyllinen löytää aiheita nopeasti.

Ole tiivis mutta perusteellinen

Koska tekninen asiakirja kirjailija, se &todellisten tuloste; s vaikea todella tietää kuinka paljon ja millaista tietoa panna tämän asiakirjan. Voit kirjoittaa suuri asiakirja, yritä olla lyhyt, mutta perusteellinen. Mitä tämä tarkoittaa sitä ei mennä ja ja osaksi kaikenlaisia ​​yksityiskohtia tietyillä alueilla, joita ei tarvita lukija. Se ei ole helppo sanoa, mikä &'; n asiaan ja mitä isn &'; t - mutta yrittäneet pohtia lukijan ja kohderyhmä kun Käytät uudelleen kirjoittamista asiakirja. Jos olet liian “ monisanainen &"; tai käytä liikaa tiedot, jos se &todellisten tuloste; s tarpeeton, se kytkeytyy lukijoita pois ja se voitti &'; t olla tehokas asiakirja.

Ole johdonmukainen koko Asiakirjan

Johdonmukaisuus on tärkeä tapa parantaa asiakirja. Se tekee se näyttää enemmän ammatillista, ja itse asiassa enemmän luettavissa käyttäjälle. Kun sanon johdonmukaisuus, tarkoitan säännöllisyys sekä mongerrus käytät ja muotoilua soveltavat. Jotkut yksilöt voitti &'; tätä huomaa. Kuitenkin, jos Käytät uudelleen säveltäminen tekninen asiakirja, se &todellisten tuloste; s enemmän kuin todennäköistä muihin teknisiin käyttäjille, jotka ovat yleensä yksityiskohta keskittynyt ihmisiä. Varmista asiakirjassa käytetään samaa muotoilua kaikkialla. Yritä rikkoa tiedot ja tehdä se ymmärrettävää käyttäjille hyödyntämällä valkoista tilaa tehokkaasti.

Käyttämällä samaa ilmaisuja on myös suositeltavaa. Tämä todennäköisesti varmistetaan, että käyttäjä tietää Käytät uudelleen kirjallisesti saman asian käyttämällä samoja sanoja. Jos käyttää sanoja synonyymeinä, esimerkiksi “ työpöydän &" ;, “ PC &" ;, “ tietokone &" ;, se voisi hämätä käyttäjää, kun itse tarkoittavat samaa asiaa. Että &'; sa nopea esimerkki, mutta ajatus on, että sinun pitäisi valita yhden lukukauden ja pysyä sen kanssa.

Keep It tarkkoja ja virheettömän

Se melkein itsestään selvää, että tekniset asiakirjat todella olisi virheetöntä. Kuten edellä totesin, melkoisesti lukijat asiakirja on muita teknisiä käyttäjiä, ja siellä &'; sa melko hyvä mahdollisuus virheet erottuvat ne. Tämän lisäksi, jos virheet Don &'; t hypätä pois, niin se antaa heille vääriä tietoja järjestelmän tai alue, joka Käytät uudelleen dokumentointiin - joka voittaa asiakirjan tarkoitus!

Vältä suuri näyttö kaappaa

hyödyntäminen kuvakaappauksia tai kuvakaappauksia omassa asiakirjat on ehdottomasti tehokas tapa selittää teidän pisteen lukijalle. Se &'; s ensisijaisesti hyötyä ohjelman oppaat tai tukiprosessien, jotka on helppo ottaa ruutukaappauksia. Kuitenkin tietokone näytöt ovat saaneet suurempia vuosien varrella, mutta A4-arkit ovat aina olleet samankokoisia.

Tämä jättää kaltevuus sisällyttää suuri kuvakaappauksia asiakirjassa, joka tekee kuvakaappauksia pieni ja tehoton. Mukaan lukien kuvakaappauksia on hyvä idea - Don &'; t ymmärtäkö minua väärin - mutta pyrittävä sisältävät vain alueilla, jotka liittyvät osa Käytät uudelleen selittää. Tämä johtaa yleensä siihen enemmän kuvakaappauksia, mutta ne ovat tehokkaampia ja tehdä asiakirjan luettavuutta.
.