Tekninen kirjoittaminen – Tietoja vuokaavioista

By | 20 lokakuun, 2021

”Matkalla ei ole mitään merkitystä itsessään; se tulee kokonaan kahdesta kohdasta, jotka yhdistävät sen merkityksen.” – Milan Kundera, 1929-, tšekkiläinen kirjailija, kriitikko

Mikä on vuokaavio?

Vuokaavio voidaan määritellä graafisena esityksenä toiminnasta tai vaiheesta. Toisin sanoen se kuvaa projektin tai prosessin eri vaiheita.

Yleensä vuokaavio sisältää monia ruutuja, nuolia ja tekstiä, jotka yhdistyvät ja muodostavat sekvenssin.

Miksi luoda vuokaavio?

Vuokaavion tarkoituksena on näyttää prosessin vaiheet valokuvassa. Katsoessasi vuokaaviota katsojan pitäisi pystyä tunnistamaan prosessin eri vaiheet.

Vuokaaviot voivat olla erittäin hyödyllisiä tekniselle kirjoittajalle. Jos työskentelet monimutkaisen prosessin parissa, vuokaavio voi näyttää useita prosessiin liittyviä vaiheita. Työskentelit esimerkiksi käsikirjan parissa Boeing 747 Autopilot Flight Director -järjestelmän korjaamiseksi. Tämän järjestelmän korjaamiseksi on useita vaiheita. Jokaisessa vaiheessa on useita alivaiheita. Luomalla vuokaavion näet nopeasti, mitä prosessin vaiheita tapahtuu.

Vuokaavion luominen

Kun työskentelet monimutkaisen projektin parissa, saman vuokaavion luominen voi viedä kauan. Seuraavassa on joitain vuokaavioita, joiden avulla voit luoda monimutkaisia ​​kaavioita:

1. Aluksi määritellään prosessin tai projektin lopputulos. Lopputulos voi olla esimerkiksi käyttöoppaan täyttäminen, monimutkaisen ohjelmistoprosessin kirjoittaminen, uuden osan asentaminen tai testin tekeminen.

2. Luettele useita vaiheita lopullisen tuloksen saamiseksi. Tämä vaatii jonkin verran tutkimusta. Monimutkaisissa prosesseissa jokaisessa vaiheessa voi olla joitain alivaiheita. Käyttöoppaan luominen voi olla seuraava:

a. Tapaa pk -yrityksiä

b. Tutki olemassa olevia asiakirjoja

c. Videotallennusmenettely

d. Ottaa valokuvia

e. Luo kuvituksia

f. Laadi käyttöopas

g. Testaa käyttöopas

h. Tee muutoksia / säätöjä

i. Toimita lopullinen tuote

3. Määritä projektiprosessin lähtökohta. Tämä on prosessin ensimmäinen askel. Ensimmäinen askel voi olla esimerkiksi hankesuunnittelu tai tutkimus.

4. Kirjoita lähtökohta ja lopputulos. Näiden kahden tulisi olla laatikoissa ja niiden välissä on väli. Säädä tätä tilaa prosessiin liittyvien vaiheiden ja alivaiheiden määrän mukaan.

5. Piirrä nuoli aloituskohdasta lopputulokseen.

6. Luettele tämän nuolen ohella useita vaiheita siirtyäksesi aloituspisteestä lopputulokseen. Syötä tarvittavat alivaiheet.

Joillakin prosesseilla voi olla useita vaiheita. Esimerkiksi siirtyäksesi vaiheesta 1 vaiheeseen 2 voi olla kolme vaihtoehtoa. Osoitat sen vuokaaviossa kolmella erillisellä nuolella vaiheesta 1 vaiheeseen 2.

Vuokaavio on kuin etenemissuunnitelma. Siinä on lähtökohta (A) ja päätepiste (B). Tavoitteesi on päästä pisteestä A pisteeseen B. Kaavio osoittaa, mitä prosessiin liittyy.

Kaavio voi olla erittäin hyödyllinen työkalu tekniselle kirjoittajalle eri toimintojen ja prosessien havainnollistamiseen. Ennen kuin aloitat seuraavan projektin, katso, voitko havainnollistaa prosessia kaavion avulla. Se helpottaa sinun ja esimiehesi tai asiakkaan elämää. Lopputuloksena on parempi projekti, joka on hyvä kohdeyleisöllesi.

Huomautus: Microsoft Visio on hyvä ohjelmisto vuokaavioiden luomiseen.

Vastaa

Sähköpostiosoitettasi ei julkaista. Pakolliset kentät on merkitty *