Tekninen kirjoittaminen vaatii yleensä kahden tyyppistä tietoa: väestörakenteen, jonka kirjoituksesi lukee, ja jonkin verran ymmärrystä käsillä olevasta teknisestä aiheesta.
Tekninen kirjoittaminen vaatii yleensä kahden tyyppistä tietoa: väestörakenteen, jonka kirjoituksesi lukee, ja jonkin verran ymmärrystä käsillä olevasta teknisestä aiheesta.
Ymmärrä yleisösi. Sinulle voidaan antaa raportti siitä, kuka yleisö kirjoitusta varten on, tai joudut ehkä selvittämään sen itse. Kummassakin tapauksessa sinun on tiedettävä lukijoiden perusdemografia, mukaan lukien kuinka paljon teknistä tietoa heillä on käsillä olevasta aiheesta. Ohjelmiston uusien käyttäjien yleisö on kirjoitettava paljon eri tavalla kuin edistyneiden ohjelmoijien ryhmä. Teknisen ammattikielten käyttöä on mukautettava vastaavasti. Aseta itsesi lukijan paikalle ja kirjoita mahdollisimman selkeästi.
Tunne aiheesi. Jos olet säännöllinen tekninen kirjoittaja, sinun ei ehkä ole mahdollista tietää kaikkia kaikista aiheista, joista kirjoitat. Mutta sinun on tiedettävä siitä tarpeeksi, jotta voit olla varma siitä, että pystyt kommunikoimaan tarkasti.
Käytä nykyhetkeä. Ellei sinulle ole erikseen annettu ohjeita käyttää eri jännitettä, tekninen kirjoittaminen tulisi aina tehdä nykyisessä ajassa.
Ole objektiivinen. Tekninen kirjoittaminen tulisi tehdä objektiivisella tavalla, ilman johtopäätöksiä eikä henkilökohtaisia pronomineja.
Kirjoita sisällysluettelo. Sisällysluettelo on välttämätön melkein missä tahansa teknisessä kirjoituksessa, ja se auttaa lukijoita löytämään eniten tarvitsemansa tiedot.
Käy läpi vaiheiden luettelot. Vaiheet, jotka tulisi suorittaa tehtävän suorittamiseksi, laitteiden käyttämiseksi, ohjelmiston suorittamiseksi jne., Tulisi kirjoittaa yksitellen. Muista kattaa kaikki kysymykset, joita voi syntyä jokaisesta vaiheesta. Vaiheiden tulisi olla numeroituja järjestyksessä, ja niihin olisi oltava pääsy sisällysluettelon kautta.
Tekninen kirjoittaminen tulisi tehdä objektiivisella tavalla, ilman johtopäätöksiä eikä henkilökohtaisia pronomineja.
Käytä työkaluja ja taulukoita. Pitkällä teknisellä kirjoituksella on usein itselleen rakentuvaa tietoa - pääinformaatio on ymmärrettävä ennen kuin loppuosa voi olla. Joskus voi olla hyödyllistä sisällyttää merkittyjä kuvia, kaavioita ja tietotaulukoita, jotta pääset läpi monimutkaisia ideoita, joita on vaikea kuvata sanoin tai joihin on viitattava myöhemmin asiakirjassa.
Käytä erityisiä huomautuksia. Ohjeiden lisäksi on tapauksia, joissa erityisten huomautusten käyttö tekstissä on hyödyllistä lukijalle. Ilmoituksia ovat varoitukset, varoitukset mahdollisista vaarallisista tilanteista jne. Erityiset ilmoitukset voivat sisältää suojaavia ideoita, kuten suojalasien tai tuuletetun työtilan käytön suositteleminen. Saattaa myös olla ilmoituksia siitä, mitä tehdä, jos jokin vaihe on tehty väärin, kuinka korjata virheet jne.
Testaa asiakirja. Usein on hyvä testata asiakirja kohderyhmän lähellä olevan henkilön kanssa, joka voi kertoa, puuttuuko tietoja. Jos asiakirja on tarkoitettu tiedon aloittaville käyttäjille, sen pitäisi olla helppo löytää joku samankaltaisesta tilanteesta. Jos hän pystyy lukemaan asiakirjan ilman lisäkysymyksiä tietojen käytöstä, asiakirja on täydellinen.
