Ammatillinen ja tekninen kirjoittaminen/ohjeet

Välttäkää vakuuttelevaa kieltä ja käyttäkää tehtäväkohtaista lähestymistapaa, kun kirjoitatte ohjeita. Pidä kirjoitus tiiviinä ja selkeänä ja keskity siihen, että käyttäjä voi suorittaa tehtävän menestyksekkäästi.

Noudata yleisesti ottaen seuraavia ohjeita:

Yhteys ja selkeys

Pitäkää lauseet lyhyinä ja ymmärrettävinä. Käytä yleistä terminologiaa aina kun mahdollista. Vältä idiomien, slangin, jargonin, lempinimien, lyhenteiden ja akronyymien käyttöä. Jos käytät terminologiaa, joka saattaa olla uutta tai hämmentävää, määrittele kukin termi selkeästi, kun se esiintyy ohjeissa ensimmäisen kerran.

Audience

Ohjeita kirjoittaessasi on tärkeää tuntea yleisösi, jotta voit sisällyttää niihin kaiken tarpeellisen tiedon ja jättää pois tarpeettoman tiedon. Kun tunnet yleisösi, voit tehdä järkeviä ja perusteltuja oletuksia, jotka perustuvat yleisön todennäköiseen taustaan, kokemukseen ja perehtyneisyyteen aiheeseen. Jos esimerkiksi kirjoitat ohjeita paikallisessa kirjastossa työskentelevälle eläkeläisryhmälle, ei ehkä ole turvallista olettaa, että he tuntevat tietyn ohjelmasovelluksen avaamisen perusteet. Jos kuitenkin kirjoitat ohjeita ammattijärjestön ohjelmistokehittäjien ryhmälle, voi olla turvallista olettaa, että he tuntevat tietyn ohjelmasovelluksen avaamisen perusteet.

Päättäessäsi, mitä tietoja sisällytät ja mitä jätät pois ohjeista, on tärkeää tunnistaa selvästi, kuka on yleisösi ja mikä on heidän todennäköinen taitotasonsa ohjeiden aiheen ja siihen liittyvien taustatietojen suhteen.

Jos yleisöllä on todennäköisesti monenlaista kokemusta ja tietämystä, joka sisältää vaihtelevia perehtyneisyyden ja asiantuntemuksen tasoja, voit käyttää erilaisia tekniikoita pitämään jokaisen ohjeen tiiviinä ja keskittyneenä yksittäiseen tehtävään, mutta antaa silti tarvittavat tiedot. Voit esimerkiksi laatia erilliset ohjeet ennakkotietoja varten ja antaa yleisöllesi keinot, joiden avulla se pääsee nopeasti ja helposti käsiksi erillisiin ohjeisiin (hyperlinkkien, liitteiden jne. avulla).

Grafiikka

Kuvat puhuvat enemmän kuin sanat. Grafiikan lisääminen ajatusten välittämiseksi voi olla tehokkaampaa kuin itse sanat. Hyvin kuvitetut ohjeet, jotka liittyvät kirjallisiin ohjeisiisi, ovat yleensä erittäin onnistuneita. Se lisää ymmärrettävyyttä ja antaa lukijalle mahdollisuuden selata tai etsiä vikoja, jos ongelmia ilmenee. Kuvat lisäävät lisäulottuvuuden, jonka avulla lukijasi voi visualisoida lopputuotteen. Myös grafiikkaa käyttäessäsi sinun tulee ottaa huomioon ne visuaalisesti oppivat henkilöt ja mukauttaa grafiikkaa.

Vaikka kuvat ovatkin hienoja, sinun on oltava varovainen, ettet sisällytä valokuvia tai kuvituksia, jotka ovat hämmentäviä tai jotka eivät liity varsinaisiin kirjallisiin ohjeisiin. Jos yhdistät huonon kuvan ohjeisiisi, saatat aiheuttaa lukijalle stressiä tai aiheuttaa hämmennystä, kun hän yrittää tulkita, mitä tarkoitat.

Varmista myös kuvia ottaessasi, että alue on hyvin valaistu ja kuvat ovat selkeitä ja kirkkaita. Tummia tai epäselviä kuvia on usein vaikea seurata. Huolehdi siitä, että kuvaat kohteen joka kerta samassa suunnassa sekaannusten välttämiseksi, ja harkitse jalustan käyttöä.

Koko on myös tärkeää, kun käytät kuvia ohjeissa. Liian pieni kuva on yhtä hyödytön kuin epäselvä kuva.

Voidaksesi olla tehokas ja ymmärrettävä, kunkin vaiheen tekstisi ja grafiikkasi tulisi korreloida selkeästi ohjeen kyseisen vaiheen kanssa.

Muotoilu

Muista, että lukijat todella suorittavat tehtävän, kun he lukevat ohjeita. Siksi sinun ei pitäisi käyttää kiinteitä, pieniä, vaikeasti ymmärrettäviä tekstilohkoja. Muista luoda ohjesivullesi sellainen muotoilu ja ulkoasu, joka mahdollistaa helpon luettavuuden ja lisää esteettistä laatua. Sivun pitäminen yksinkertaisena, mutta määritellyn hierarkian avulla lukijaa autetaan suorittamaan ohjeiden vaiheet.

Sivua suunniteltaessa vankka hierarkia on tärkeää skannattavuuden kannalta. Lihavoitujen otsikoiden, kursiivien ja roomalaisten numeroiden käyttö auttaa lukijaa löytämään paikkansa helposti ja auttaa visuaalista yleisilmettä.

Orjestys

On tärkeää, että ohjeesi suunnitellaan loogisesti eteneviksi. Varmista, että ongelma ilmaistaan selkeästi ensimmäisellä sivulla. Seuraa ongelmiesi jälkeen joukko erityisiä vaiheita, joissa kerrotaan yksityiskohtaisesti, miten ehdotettu ongelma ratkaistaan. Teknisten ohjeiden on kuljettava loogisesti. Esimerkiksi pöytää koottaessa ei olisi hyvä, jos laittaisit pöydän viimeistelyt ennen kuin kaikki ruuvit ovat paikoillaan. Kuten edellä todettiin, ohjeessa on myös oltava tarvittaessa selkeää grafiikkaa, joka selventää toimintaa. Muista, että kuva kertoo enemmän kuin tuhat sanaa.

Testaus ja todentaminen

Me kaikki tiedämme, että ohjeita on vaikea kirjoittaa ja että joskus se kuulostaa hyvältä paperilla, mutta kun yrität oikeasti ottaa ohjeet käyttöön, saatat huomata, että sanamuodossasi ei ole mitään järkeä muiden mielestä. Muista, että se, mikä sinulle saattaa olla yleistä tai itsestään selvää, saattaa hämmentää lukijoitasi, joten tunne yleisösi. Sen lisäksi, että testaat ohjeesi itselläsi, pyydä jotakuta, joka ei tiedä tuotteestasi mitään, testaamaan ne. Tätä kutsutaan käytettävyystutkimukseksi. Tee muistiinpanoja siitä, mikä toimi ja mikä ei, ja muokkaa sitten ohjeitasi sen mukaan. Pitkällä tähtäimellä mitä useammat ihmiset testaavat ohjeitasi, sitä tehokkaampi lopullisesta kokonaisuudesta tulee.

Vastaa

Sähköpostiosoitettasi ei julkaista.