Tekninen kirjoittaminen 101 Osa I

Tekninen kirjoittaminen on ollut intohimoni jo vuosia. Olen itse aloitti Help Desk tukihenkilö dokumentointi teknisiä ohjeita työntekijöiden ja uusien työntekijöiden, ja sitten siirtyi projektityö dokumentointia ohjelmakoodia ja teknisissä suurissa hankkeissa. I &'; ve kirjoittanut myös kurssin paikallisen yhteisön college minun alueella ja opetti sen myös. Halusin jakaa joitakin minun oivalluksia kurssista koska niin monet osallistujat ollut apua. He jopa tekivät tarkastelun US1 Princeton sanomalehti! :-D

Joka tapauksessa, minä eksyä … mielestäni on 4 avaimet teknistä kirjoitusta ja minä kutsuvat sitä DOPS menetelmä. Anna &'; katsaus kunkin pisteen.

D on määrittelyyn yleisö – Ei vain sinun täytyy tietää, kuka olet kirjallisesti, mutta sinun täytyy tietää tietojaan taso ja tietoisuutta asetettu aihe. Esimerkiksi, jos opetat MS Word ylimmän johdon ja he eivät edes osaa käyttää Outlookin tai siirry Windows, voit joutua uudelleen arvioida sisältöä ja kieltä kirjoitat. Yritä vältellä monimutkainen teknisiä termejä ja alkaa perus katsaus työkalurivien tai edes miten avata sovelluksen.

O on Jäsennys. Henkilökohtaisesti uskon, että tämä on avain menestykseen. Näen niin monet kirjailijat vain istua alas ja alkaa kirjallisesti ilman suuntaa ja voit kertoa virtauksen niiden asiakirjan. Et yksinkertaisesti voi seurata “ ajatusketju &" ;. Ota aikaa hahmotella koko asiakirjan sisältöä otsikko sivun ja jopa graafinen muistiinpanot, Ristiviittausten ja sisältöä, aina lisäyksen, jättäen TOC (sisällysluettelo) Täytetään viime. Luota minuun näet suuri ero virtauksen asiakirjoja.

P on määrittelyyn tarkoitus – Vihaan käyttää lyhenteitä sisälle lyhenteitä, mutta haluan viitata tätä TRIIP teoria. Tarkoitus luoda asiakirja voi olla opettaa, Suosittele ilmoitettava, korot, tai suostutella. Esimerkiksi, jos olet tekninen kirjoittaja uutta ohjelmistosovellus henkilöstöosasto, ja sinun tehtäväsi on kirjoittaa asiakirja työntekijöille, jotka käyttävät tätä uutta sovellus, mikä on tarkoitus? Tässä tapauksessa on opettaa. Täällä &'; s toinen: Jos palkattu tekninen kirjoittaja luoda dokumentin tarkoituksena on antaa työntekijöille tietää uusia politiikkoja ja menettelyjä, mikä on tarkoitus? Tässä tapauksessa vastaus on ilmoittaa. Käytät uudelleen ei tehdä suositusta, että ne noudattavat menettelyjä tai yrittää kiinnostavat heitä tai suostutella heitä seuraamaan politiikan ja menettelyt; sinun täytyy vain kertoa heille.

S on vaiheet kirjoittaminen. Mielestäni on olemassa 3 askelta vaiheita, niin sanoakseni, ja Ei minulla ei ole lyhenne sanoista tämä yksi. LOL 3 vaiheet ovat suunnitelma, luonnos ja tarkistaa. Kun olet suorittanut koko suunnitelman asiakirjan, mukaan lukien arviointi yleisö ja yksityiskohtainen hahmotelman ehkä muutama luonnoksia, voit alkaa luoda asiakirjaluonnos. Jos et ole uusi tekninen kirjoittaminen tiedätte hyvin, että ensimmäinen asiakirja luotu on aina luonnos. Sinulla on monia, monia tarkistuksia useita ihmisiä ennen lopullisen asiakirjan on hyväksytty. Toivottavasti tehnyt &'; t pelästyttää ketään pois vielä!

Joten meillä on, DOPS menetelmä Cheryl McNeil. On niin paljon enemmän tekniikan kirjoittaminen, mutta ajattelin vain antaa esikatselu siitä, mitä on tulla minun seuraava artikkeli, osa II Tekninen kirjoittaminen 101. Kunnes seuraavan kerran …

Resurssit luomiseen outlines:

http://owl.english.purdue.edu/handouts/general/gl_outlin.html
http://www.albany.edu/eas/170/outline.htm
http://wiki.ehow.com/Write-an-Outline
.