Tehniline kirjutamine – vooskeemide kohta

By | november 14, 2022

“Marsruudil pole iseenesest tähendust; selle tähendus tuleneb täielikult kahest punktist, mida see ühendab.” – Milan Kundera, 1929-, tšehhi autor, kriitik

Mis on vooskeem?

Vooskeemi saab määratleda kui toimingute või sammude jada graafilist esitust. Teisisõnu, see on näide projekti või protsessi erinevatest etappidest.

Tavaliselt koosneb vooskeem mitmest kastist, nooltest ja tekstist, mis koos moodustavad järjestuse.

Miks luua vooskeemi?

Vooskeemi eesmärk on näidata protsessi erinevaid etappe hetketõmmisena. Vooskeemi vaadates peaks vaataja suutma tuvastada protsessi erinevad etapid.

Vooskeemid võivad olla tehnilisele kirjutajale väga kasulikud. Kui töötate keerulise protsessi kallal, võib vooskeemil näidata teile selle protsessi erinevaid samme. Näiteks võite töötada käsiraamatu kallal, kuidas teha Boeing 747 lennukite Autopilot Flight Directori süsteemi tõrkeotsingut. Selle süsteemi tõrkeotsing hõlmab erinevaid samme. Igal etapil on mitu alametappi. Vooskeemi loomisel näete kiiresti, milline etapp millises protsessi etapis toimub.

Kuidas luua vooskeemi

Kui töötate keeruka projektiga, võib vooskeemi loomine olla aeganõudev ülesanne. Siin on kuus lihtsat sammu, mida saate järgida isegi keerukate vooskeemide loomiseks.

1. Alustage protsessi või projekti lõpptulemuse määratlemisest. Lõpptulemus võib olla ükskõik milline, näiteks kasutusjuhendi täitmine, keeruka tarkvaraprotsessi kirjutamine, uue osa installimine või testi tegemine.

2. Loetlege erinevad sammud lõpptulemuse saavutamiseks. See võtab veidi uurimistööd. Keerulistes protsessides võib igal etapil olla rida alametappe. Kasutusjuhendi loomise etapid võivad olla järgmised:

a. Kohtuge VKE-ga

b. Uurige olemasolevat dokumentatsiooni

c. Videolindile protseduur

d. Fotosid tegema

e. Loo illustratsioone

f. Töötage välja kasutusjuhend

g. Testige kasutusjuhendit

h. Tehke muudatusi/kohandusi

i. Tarnige lõpptoode

3. Määratlege projekti protsessi alguspunkt. See on esimene samm, mis protsessi käivitab. Näiteks võib esimene samm olla projekti planeerimine või uurimine.

4. Pane kirja alguspunkt ja lõpptulemus. Mõlemad peaksid olema kastides, mille vahel on ruumi. Reguleerige seda ruumi vastavalt protsessis osalevate sammude ja alametappide arvule.

5. Joonista nool alguspunktist lõpptulemuseni.

6. Loetlege selle noole äärde erinevad sammud, mis on vajalikud alguspunktist lõpptulemuseni jõudmiseks. Vajadusel lisage kõik alamtoimingud.

Mõned protsessid võivad hõlmata mitut etappi. Näiteks 1. toimingust 2. sammuni jõudmiseks võib olla kolm võimalust. Illustreeriksite seda vooskeemil kolme eraldi noolena, mis kulgevad 1. sammust 2. sammuni.

Vooskeem on nagu teekaart. Sellel on alguspunkt (A) ja lõpp-punkt (B). Teie eesmärk on jõuda punktist A punkti B. Vooskeem ütleb teile, mis protsessi kaasatakse.

Tehnilise kirjutaja jaoks võib vooskeem olla väga kasulik tööriist erinevate toimingute ja protsesside illustreerimiseks. Enne järgmise projekti alustamist vaadake, kas saate protsessi vooskeemi abil illustreerida. See muudab teie ja teie juhi või kliendi elu lihtsamaks. Lõpptulemus on parem projekt, mis on teie sihtrühmale hea.

Märkus. Microsoft Visio on hea tarkvara vooskeemide loomiseks.

Lisa kommentaar

Sinu e-postiaadressi ei avaldata. Nõutavad väljad on tähistatud *-ga