Tekninen kirjoittaminen 101 Osa 2

Osa 1 I jakanut ajatuksiani määritellään yleisö, luo ääriviivat, määritellään sinun tarkoitukseen ja vaiheissa kirjallisesti. Nyt haluaisin ottaa hetki ja laajentaa aluetta määriteltäessä yleisöön. Esimerkiksi, mitä sinun tarvitsee tietää niistä ja miksi.

Ensimmäinen askel on selvittää niiden taso tietoa aiheesta. Ovatko he …
Expert taso? &Ndash; edistyneellä tasolla aiheeseen
Semi-asiantuntijatasolla? &Ndash; klo keskitason aiheeseen
Asiantuntematon tasolla? &Ndash; ei ole aiempaa tietoa aihe

Toinen askel on selvittää niiden roolia organisaatiossa. Ovatko he …
• Esimiehet? &Ndash; korkein arvovaltaisten organisaation sisällä, kuten puheenjohtaja tai varapuheenjohtaja tai johtaja. Ne, jotka tekevät päätöksiä, jotka vaikuttavat koko organisaation.
&Bull; Alaistensa? &Ndash; lukijat tasolle organisaatiossa alempi kuin tekninen kirjoittaja. Kaikki he välittävät on, miten asiakirja vaikuttaa työnsä.
&Bull; Ikäisensä? &Ndash; lukijat samalla tasolla kuin tekninen kirjoittaja, mutta ei välttämättä samalla osastolla tai Kenttien.

Ja kolmas askel on selvittää, miksi ne lukea tekninen asiakirja ensiksi. Johtuuko se siitä, …
• heidän täytyy? tai on määrätty niiden manageri?
• ne ovat todella kiinnostuneita aiheesta?
• ne vain käyttää sitä apuna samalla täydentämään jokapäiväisessä työtehtäviin?

Sinulla voi olla miettimättä, miksi nämä vaiheet ovat jopa tärkeitä tekninen kirjoittaja. No, syy on se, jos kirjoitat tai suunnittelet asiakirjan väärässä yhteydessä, väriä tai asettelua se voisi tehdä tai rikkoa koko projektin.

Esimerkiksi, et halua kirjoittaa asiakirjan esimiehille ilman tietoa aihe on erittäin tekninen nimiin tai haluat kirjoittaa alentuvalla tavalla joko. On oltava ammatillinen tasapaino näiden kahden joka harjoittaa oppijan ja auttaa heitä omaksua tietoa tehokkaasti ja käyttää teknisen asiakirjan tehokkaasti.

Anna &'; s katsomaan toinen esimerkki. Kirjoitat tiimin oman ikäisensä, jotka ovat Jatko tietotasoa. Mitä luulet olisi vastaus lukijoita, jos olet luonut dokumentin, joka selittää jopa alin tekninen termi kuten mitä on ja ', hiiri &'; tai miten “ Click &" ;? Ne luultavasti tylsää ja loukkaantunut samalla, Don &'; t luulet?

Joten jälleen, avain on määritellä yleisö kysymällä niin monta kysymystä kuin mahdollista. Jos voit päätyä liian monta tasoa ja organisatorisia rooleja yleisö, ehkä luoda 3 erillistä asiakirjoja, kuten Aloittelijan opas, Intermediate käyttöopas ja Advanced User Guide.

Osa 3 Haluan keskittyä siihen, miten kerätä resursseja ja mistä, ja mitkä ovat graafisia tuet tai vihjeiden sisällä tekniset asiakirjat ja miten luoda niitä. Kunnes seuraavan kerran …

Resource: Tekninen kirjoittaminen: periaatteet, strategiat, ja lukemat Diana C. Reep (5. painos.) Pearson Education, Inc. 2003.
.