Mitä on tekninen kirjoittaminen? Täydellinen opas

Kun kamppailet uuden vekottimen kanssa, haet käyttöohjeen.

Kun olet juuttunut ohjelmiston asentamiseen, tutustu ohjesivuihin.

Kun autostasi kuuluu outo ääni, selaat hansikaslokeron käsikirjaa.

Kaikki nämä ovat esimerkkejä tekninen kirjoittaminen - Jotain, johon luotamme joka päivä, mutta jota harvoin ajattelemme.

Glassdoorin mukaan SpaceX:n tekninen kirjoittaja ansaitsee välillä $88,000 - $138,000 vuodessa. 

Silti useimmat ihmiset eivät vieläkään ymmärrä, mitä tekninen kirjoittaminen oikeastaan on.

Se ei ole vain kirjoittamalla ohjeet.

Se ei ole vain kääntäminen insinöörien puheesta selkokielelle.

Eikä se ole edes vain luominen käyttöoppaat tai ohjeasiakirjat. 

Mitä on tekninen kirjoittaminen? Miten se eroaa muunlaisesta kirjoittamisesta? Millaisia ovat sen eri muodot? Miten sinusta voi tulla tekninen kirjoittaja? Ja miten tekoäly voi auttaa matkan varrella? 

Tässä blogissa käsittelemme kaikkea tätä - ja paljon muuta - ja paljon muuta. Sukelletaanpa mukaan! 

Mitä on tekninen kirjoittaminen?

Maallikon kielellä tekninen kirjoittaminen tarkoittaa sitä, että hankalat ja yksityiskohtaiset aiheet selitetään tavalla, jota kuka tahansa (oikean taustan omaava) voi seurata. 

Esimerkiksi, tämä sisältää:

• Käyttöohjeet - Puhelimesi mukana tulleeseen vihkoon? Se on teknistä kirjoittamista.
• API-dokumentaatio - Myös kehittäjät tarvitsevat ohjeita. API:t eivät selitä itseään.
• Tekniset raportit - Insinöörit ja tiedemiehet käyttävät niitä tutkimuksen ja tulosten jakamiseen.

Tekninen kirjoittaminen ei ole vain sitä, mitä kirjoitat, mutta miten kirjoitat sen. Se käyttää:

• Imperatiivinen tunnelma - Sen sijaan, että "Sinun pitäisi klikata nappia," se on vain "Klikkaa nappia." 

• Passiivinen ääni (tarvittaessa) - Jos ei ole väliä sillä, kuka teon teki, passiivi auttaa. "Tiedosto poistettiin" toimii paremmin kuin "Joku poisti tiedoston" jos tarkennus on tiedostossa.

Jotkut luulevat, että tekninen kirjoittaminen on vain kirjoittamista SaaS-tuotteisiin tai tekniikkablogeihin. 

Mutta kyse ei ole markkinoinnista tai tarinankerronnasta. 

Tekninen kirjoittaminen on hyvin erityyppisiä (käsitellään pian) - kaikilla on sama tarkoitus: esittää tiedot täsmällisesti, selkeästi ja toimivalla tavalla. 

Miten tekninen kirjoittaminen eroaa muista kirjoitustyyleistä?

Ymmärretään kuusi seikkaa, joiden perusteella tekninen kirjoittaminen eroaa muista kirjoitustyyleistä.

Luovat kirjailijat käyttävät moniselitteisyyttä tai metaforia, jotta yleisö kiinnostuisi. 

Tekniset kirjoittajat eivät pyri epäselvyyksiin. 

He haluavat asettaa selkeyden luovan ilmaisun edelle, mutta se on tämän työn luonne. 

Miksi tekninen kirjoittaminen on välttämätöntä eri toimialoilla

Kuvittele lentäjä lukemassa tätä käsikirjaa kesken lennon, kun hänen on ymmärrettävä jotain kiireellisesti:

"Säädä työntövoiman vektorointi kompensoimaan epäsymmetrinen työntövoiman poikkeama panemalla täytäntöön standardipoikkeamaprotokolla 5.3b ottaen huomioon ilmakehän tiheysmuuttujat."

Tai kuvittele kirurgi, joka tarkastelee toimenpideohjeita hetkeä ennen kriittistä leikkausta: 

"Leikkaa faskiaalisten tasojen suuntaisesti ottaen huomioon taustalla olevat neurovaskulaariset rakenteet ja säilyttäen hemostaasi koko leikkuusekvenssin ajan." 

Vaikka he olisivat lääkäreitä tai lentäjiä, jotka ovat opiskelleet tätä koko uransa ajan, he eivät haluaisi lukea tätä hätätilanteessa. 

Se aiheuttaa sekaannusta ja turhautumista, jota kaikki haluaisivat välttää tilanteesta riippumatta.

Tarkastellaan viittä tärkeintä syytä, miksi tekninen kirjoittaminen on ehdottoman tärkeää: 

1. Riskien vähentäminen ja vaatimustenmukaisuus - Terveydenhuollon, rahoituksen ja ilmailun kaltaisilla aloilla virheet eivät ole vain kalliita, vaan ne voivat olla jopa tappavia. 
   • Esimerkiksi, Entä jos hoitaja tulkitsee annostusohjeet väärin epäselvän sanamuodon vuoksi? Asianmukainen dokumentointi estää tällaiset virheet. 

2. Tietämyksen säilyttäminen ja siirto - Ihmiset jättävät työpaikan, saavat ylennyksen tai jäävät eläkkeelle. Mutta mitä tapahtuu kaikelle heidän päässään olevalle tiedolle? Ne dokumentoidaan asianmukaisesti teknisen kirjoittamisen avulla. Hyvin dokumentoitu prosessi tarkoittaa, että seuraava henkilö voi siirtyä tehtävään aloittamatta kaikkea alusta.

3. Asiakastyytyväisyys ja pienemmät tukikustannukset - Oletko koskaan yrittänyt asentaa uutta laitetta ja päätynyt katsomaan satunnaista YouTube-opetusta, koska käyttöohjeessa ei ollut mitään järkeä? Huono dokumentaatio turhauttaa asiakkaita ja kuormittaa tukitiimejä turhilla puheluilla. Hyvin kirjoitettu opas pelastaa kaiken tämän. 

4. Oikeussuoja - Sopimukset, toimintaperiaatteet ja turvallisuusohjeet toimivat todisteena riita-asioissa.
   • Esimerkiksi, Jos yritys haastetaan oikeuteen viallisesta tuotteesta, lakimiehet tarkistavat ensimmäisenä asiakirjat. Varoitettiinko ohjeissa riskeistä? Oliko turvallisuusmenettelyt esitetty selkeästi? Jos näin ei ole, yritys on pulassa.

5. Tehokkuushyötyjä standardoinnin avulla - Kuvittele yritys, jossa jokainen osasto noudattaa eri järjestelmää samaa tehtävää varten. Yksi tiimi seuraa tietoja taulukkolaskentaohjelmilla, toinen käyttää mukautettua ohjelmistoa ja kolmas vain "muistaa asioita". Se on sekasotku. Tekninen kirjoittaminen varmistaa, että prosessit ovat standardoituja, toistettavia ja skaalautuvia.

Pohjimmiltaan tekninen kirjoittaminen auttaa ehkäisemään sekaannuksia, säästää aikaa ja pitää ihmiset turvassa. 

Teknisen kirjoittamisen tyypit (esimerkkejä)

Monet ihmiset kuulevat "tekninen kirjoittaminen" ja ajattelet heti kuivia, robottimaisia käyttöohjeita - sellaisia, joita kukaan ei oikeastaan lue, ellei ole aivan jumissa. 

Tekninen kirjoittaminen on kuitenkin paljon muutakin. 

Todellisuudessa sitä on lähes kaikilla aloilla, ja sitä esiintyy monissa eri muodoissa, joista jokaisella on oma tarkoituksensa.

Seuraavassa on kuusi keskeisintä teknisen kirjoittamisen tyyppiä (esimerkkien kera):

1. Tekninen dokumentaatio - Tämä on klassinen tyyppi. Se sisältää käyttöoppaita, tuoteoppaita ja vianmääritysohjeita.  
   • Esimerkiksi, Olet juuri ostanut upouuden espressokoneen, ja olet hämmentynyt niin monista painikkeista. Sen sijaan, että arvailisit, avaat käyttöohjeen ja seuraat vaiheittaista opasta ensimmäisen kupin valmistamiseksi.
     
2. Prosessin dokumentointi - Jokaisessa yrityksessä on työnkulkuja, mutta jos ne ovat olemassa vain jonkun päässä, se on katastrofi, joka odottaa tapahtuvan. Näitä kutsutaan SOP:iksi. 
   • Esimerkiksi, Sinun on tehtävä leipomon leivonnaistaikina. Ilman SOP:ia jokainen leipä olisi erilainen. Onneksi SOP:ssa on yksityiskohtaiset tiedot jokaisesta vaiheesta - tarkat mitat, kohotusaika, paistolämpötila - joka kerta.
     
3. API-dokumentaatio - Jos ohjelmisto on aivot, API:t (Application Programming Interfaces) ovat hermostojärjestelmä. 
   • Esimerkiksi, Kyytijakosovellus haluaa reaaliaikaisia liikennetietoja, joten se integroi Google Mapsin API:n. Ilman selkeitä API-asiakirjoja he joutuisivat kokeilemaan ja erehtymään loputtomiin.
     
4. Tieteelliset/tutkimusjulkaisut - Nämä ovat tutkijoiden kirjoittamia, mutta niiden on oltava koko maailman luettavissa.  
   • Esimerkiksi, Uusi syöpähoito vaikuttaa lupaavalta, mutta ennen sen käyttöä tutkijoiden on julkaistava tutkimustietoa sen toiminnasta, sivuvaikutuksista ja eloonjäämisasteesta. Muut tarkistavat tiedot varmistaakseen ne.
     
5. Valkoiset kirjat ja tapaustutkimukset - Valkoiset paperit ovat teknisen maailman "vakuuttavia argumentteja". Tapaustutkimukset vievät asiaa pidemmälle, sillä niissä näytetään todellisia menestystarinoita ja todellisia tuloksia. 
   • Esimerkiksi, Tietoturvayhtiö varoittaa valkoisessa kirjassaan uudesta pankkiuhasta. Kuukautta myöhemmin se jakoi tapaustutkimuksen siitä, miten sen työkalu pysäytti hyökkäyksen. Pankit alkavat kiinnittää huomiota.
     
6. Sääntelyä/vaatimustenmukaisuutta koskeva dokumentaatio - Terveydenhuolto, rahoitusala ja teollisuus ovat riippuvaisia sääntelystä. Vaatimustenmukaisuusasiakirjat auttavat yrityksiä noudattamaan lakeja ja välttämään sakot, oikeudenkäynnit ja julkiset katastrofit.
   • Esimerkiksi, Lääkeyhtiön on todistettava, että uusi kipulääke on turvallinen ennen sen myyntiä. Ne toimittavat asiakirjoja, joissa luetellaan ainesosat, annostus ja haittavaikutukset, jotta vältetään oikeudelliset ongelmat.

Teknisen kirjoittamisen avaintaidot

Jos olet joskus opettanut isovanhemmillesi älypuhelimen käyttöä ilman, että he tuntevat itsensä tyhmiksi, sinusta voi tulla tekninen kirjoittaja, koska tämä on keskeinen taito.

Kaikki muut taidot voi oppia. Tässä on luettelo taidoista, joita teknisellä kirjoittajalla on oltava:

• Tutkimuskyvyt - Sinun ei tarvitse tietää kaikkea, mutta sinun on osattava löytää tarkkaa ja luotettavaa tietoa.
  
• Yleisöanalyysi - Kun tiedät, keitä lukijasi ovat, mitä he jo tietävät ja mitä heidän on saatava aikaan, se tekee kirjoituksestasi hyödyllisen. Koska tapa, jolla selität ohjelmistopäivityksen kehittäjälle, ei ole sama kuin tapa, jolla selität sen asiakkaalle.
  
• Selkeä viestintä/selkokielisyys - Teknisessä kirjoittamisessa ei ole kyse siitä, että kuulostaa fiksulta, vaan siitä, että muut tuntevat itsensä fiksuiksi. Tämä tarkoittaa sitä, että ammattikielestä on luovuttava, käytettävä yksinkertaista kieltä ja kirjoitettava niin selkeästi, ettei lukijan tarvitse koskaan arvata, mitä tarkoitat.
  
• Tietoarkkitehtuuri - Lukijat eivät aina lue alusta loppuun, vaan skannaavat. Sinun on ymmärrettävä, miten järjestät sisällön otsikoilla, bullet point -merkinnöillä ja loogisella virtauksella niin, että tieto on helppo löytää ja sulattaa.
  
• Visuaalinen viestintä - Joskus kuva selittää jotain nopeammin kuin kappale. Virtauskaaviot, kommentoidut kuvakaappaukset ja infografiikat voivat yksinkertaistaa hämmentävimmätkin käsitteet. Hyvä tekninen kirjoittaja tietää, milloin pitää kirjoittaa ja milloin näyttää.
  
• Työkalujen osaaminen - Oikeiden työkalujen tunteminen nopeuttaa prosessia. Dokumentointiohjelmia ovat esimerkiksi MadCap Flare tai Confluence ja suunnittelutyökaluja Snagit tai Figma.

• Muokkaus- ja tarkistustaidot-Ensimmäinen luonnos ei ole koskaan täydellinen. Teknisten kirjoittajien on hiottava työtään selkeyden, tarkkuuden ja täydellisyyden vuoksi ja varmistettava, että jokainen sana palvelee tarkoitustaan. Kyse on siitä, että asiakirjasta tehdään mahdollisimman helppokäyttöinen.

Kuka käyttää teknistä kirjoittamista? (Toimialat, jotka tarvitsevat sitä)

Seuraavassa on neljä alaa, joilla teknistä kirjoittamista tarvitaan eniten.

Miten tulla tekniseksi kirjoittajaksi 

Tässä on vaiheittainen opas alalle pääsemiseksi:

Vaihe # 1 - Opi perusteet

Alkuun pääseminen ei vaadi viestintä- tai englannin kielen lukutaidon tutkintoa.

Voit aloittaa ja menestyä tällä uralla, vaikka olisit opettaja, toimittaja, insinööri tai jopa lääketieteen ammattilainen.

Ota aloittelijoille sopivia kursseja ja sertifikaatteja Coursera, Udemy, tai Googlen teknisen kirjoittamisen kurssi. 

Seuraa alan blogeja kuten  Kirjoita asiakirjat ja STC (Society for Technical Communication).

Vaihe # 2 - Rakenna salkku

Valitse tuote, jota käytät päivittäin (esim. kahvinkeitin, kuntosovellus tai älykaiutin), ja kirjoita käyttö- tai vianmääritysopas. 

Olisiko se täydellistä? Ei. 

Saisitko silloin jotain konkreettista näytettävää? Ehdottomasti. 

Avoimen lähdekoodin yhteisö, kuten GitHub on avoin uusille teknisille kirjoittajille. 

Monet projektit tarvitsevat kipeästi apua dokumentoinnissa, eivätkä ne välitä siitä, jos olet uusi. 

Vaihe # 3 - Hanki aloitteleva tehtävä

Keskity tehtäviin, joiden otsikossa on "junior" tai "associate", esimerkiksi seuraavilla alustoilla. LinkedIn, Todellakinja Työskentelemme etänä. 

Älä myöskään unohda työsopimussuhteisia tehtäviä - ne ovat usein helpommin löydettävissä ja voivat johtaa pysyviin tehtäviin.

Vaihe # 4 - Edistä urakehitystäsi

Kun sinulla on itseluottamusta ja kokemusta, voit hakeutua vanhemman teknisen kirjoittajan, API-kirjoittajan tai UX-kirjoittajan tehtäviin.

Tutustu seuraavanlaisiin työkaluihin MadCap Flareja Happi XML strukturoitua kirjoittamista varten tai Markdown ja Git jos haluat työskennellä kehittäjien kanssa. Sinun ei kuitenkaan tarvitse hallita kaikkea kerralla.

Vaihe # 5 - Valmistaudu haastatteluihin

• Yleisiä kysymyksiä ovat:
  • Miten monimutkaista aihetta voi yksinkertaistaa? → Näytä kirjoitusnäyte ennen ja jälkeen.
  • Mitä työkaluja olet käyttänyt? Mainitse kaikki.
  • Miten käsittelet insinööreiltä saatua palautetta? → Anna todellinen tai hypoteettinen esimerkki. 

Vaihe # 6 - Jatka oppimista ja nouse tasolleen

Ala kehittyy jatkuvasti. Yhtenä vuonna kaikki puhuvat wikeistä, ja seuraavana vuonna kaikki puhuvat docs-as-codeista. 

Ne ihmiset menestyvät, jotka jatkavat täydennyskoulutusta. 

Seuraa TechWhirl ja Cherryleaf trendejä varten.

Aloita jo tänään. Kirjoita tuotteen käyttöohje uudelleen, jaa se LinkedInissä ja pyydä palautetta.

Teknisen kirjoittamisen työkalut ja ohjelmistot

Tekoälytyökalut helpottavat ja tehostavat työtehtäviäsi, eikä tämä koske myöskään teknistä kirjoittamista.

Tässä ovat ammattilaisten käyttämät teknisen kirjoittamisen työkalut:

1. Luonnosteluun ja sisällön muokkaukseen:

1. MS Word avulla voit luoda ammattimaisesti muotoiltuja asiakirjoja, joissa tyylit, otsikot ja ristiviitteet ovat tarkasti hallinnassa. 
2. Google Docs mahdollistaa sen, että useat tiimin jäsenet voivat työskennellä samanaikaisesti saman asiakirjan parissa. 

2. Strukturoitua dokumentointia ja julkaisemista varten: 

1. MadCap Flare avulla voit ylläpitää yhtä ainoaa sisällön lähdettä, joka julkaistaan automaattisesti eri muodoissa. 
2. Adobe FrameMaker käsittelee 500-sivuisen teknisen eritelmän, jossa on monimutkaisia taulukoita, erikoiskaavioita ja ristiviittauksia. 

3. Tiimipohjainen dokumentointi:

1. Confluence tulee yrityksesi sisäinen wiki, jossa eri osastot ylläpitävät dokumenttejaan. 
2. Ilmoitus auttaa tuotetiimiäsi organisoimaan dokumentaatiota projektinhallinnan ohella. 

4. Asiakirjojen muutosten hallintaan ja seurantaan:

1. GitHub avulla kehittäjät voivat päivittää dokumentaatiota koodimuutosten ohella.
2. BitBucket integroituu CI/CD-putkeen, jotta dokumentaatio rakennetaan ja otetaan käyttöön automaattisesti jokaisen julkaisun yhteydessä.

5. Tutkimuksen, sisällön rakenteen ja paremman luettavuuden vuoksi:

1. Essee Writer auttaa sinua dokumentoimaan monimutkaisen algoritmin sopivaan asiayhteyteen, selityksiin ja esimerkkeihin. 
2. SEO-kirjoittaja varmistaa, että julkisessa dokumentaatiossasi käytetään johdonmukaista terminologiaa ja noudatetaan parhaita luettavuuskäytäntöjä. 
3. AI Chat auttaa teknistä kirjoittajaa yksinkertaistamaan monimutkaisia käsitteitä. Se ehdottaa vaihtoehtoisia selityksiä ja yksilöi alueet, joilla käyttäjät saattavat tarvita lisäyhteyksiä. 

Miten tekoäly voi parantaa teknisen kirjoittamisen tehokkuutta?

Näin tekoäly voi auttaa sinua teknisessä kirjoittamisessa: 

1. Automaatio

Tyhjältä sivulta aloittaminen on vaikeaa. Voit käyttää tekoälyä alustavan sisällön laatimiseen strukturoitujen tietojen perusteella.

Se vähentää käsikirjojen, oppaiden ja raporttien laatimiseen kuluvaa aikaa. 

Miten se tehdään...

Käytä tekoälytyökaluja, kuten AI Chatbot luoda perusluonnoksia tai jopa ensimmäinen luonnos.

Tarkenna sitten kieltä käyttämällä alakohtaista terminologiaa ja tarkista sisältö. 

2. Kielioppi ja selkeys

Käytä tekoälytyökaluja jargonin, passiivin ja luettavuusongelmien tarkistamiseen. 

Näin sitä käytetään...

Aja luonnokset läpi AI Paraphraser. Tämä työkalu auttaa monimutkaisten lauseiden uudelleenkirjoittamisessa, ehdottaa selkokielisiä vaihtoehtoja ja parantaa yleistä luettavuutta.

3. Sisällön jäsentäminen

Hyvin jäsennelty asiakirja ehkäisee sekaannuksia.

Tekoäly voi järjestää sisällön loogisesti ryhmittelemällä toisiinsa liittyviä aiheita, lisäämällä otsikoita ja ehdottamalla ulkoasuja. 

Näin sitä käytetään..

Käytä AI essee kirjoittaja raporttien, käsikirjojen ja dokumentaation luomiseen.

Päätelmä

Tekniset kirjoittajat kääntävät "insinöörikielen" "ihmiskieleksi".

Niiden ansiosta lentäjät voivat laskeutua turvallisesti lukematta 10 000-sivuista ohjekirjaa kesken lennon, kirurgit keskittyvät ihmishenkien pelastamiseen kryptisten ohjeiden tulkitsemisen sijaan ja voit käyttää hienoa kahvinkeitintäsi ilman, että keittiössäsi syntyy vahingossa geysir. 

Monimutkaisessa maailmassamme selkeä viestintä on välttämätöntä.

Hyvä tekninen kirjoittaminen säästää aikaa, rahaa, turhautumista ja joskus myös ihmishenkiä (lääketieteellisissä ja turvallisuuskysymyksissä).

Tulevaisuudessa tulemme näkemään enemmän videoita interaktiivisten oppaiden ja asiakirjojen muodossa, jotka mukautuvat osaamistasoosi. 

Jos haluat käyttää teknisen kirjoittamisen lihaksia, valitse jokin monimutkainen asia, jonka ymmärrät hyvin - ehkäpä fotosynteesin toiminta, jalkapallon paitsiosääntö tai täydellinen kohokas - ja selitä se ystävällesi mahdollisimman selkeästi ja yksinkertaisesti. 

Jos he ymmärtävät sen tuon lasittuneen katseen sijaan, onnittelut!

Olet löytänyt teknisen kirjoittajan ydintaidon: monimutkaisen tekeminen mutkattomaksi.

Tarvitsetko lisäapua? Havaitsematon tekoäly työkalut hiovat kirjoitustasi ja pitävät sen virheettömänä. Kokeile niitä nyt!

Tutustu vapaasti AI Detector ja Humanizer alla olevassa widgetissä!