Tekninen kirjoittaminen

Tässä luvussa keskitytään ehdotukseen – sellaiseen asiakirjaan, jonka avulla sinut tai organisaatiosi hyväksytään tai palkataan tekemään projekti.

Teknisen kirjoittamisen kurssilla ehdotustehtävä on tilaisuus esitellä tietylle, nimetylle kuulijakunnalle ideasi, jolla parannat tiettyä osa-aluetta kyseisessä yrityksessä, organisaatiossa, keskuksessa tai muussa yrityksessä. Riippumatta siitä, minkä aiheen valitset, sinun on pystyttävä tekemään perusteellinen tieteellinen tutkimus, jonka sisällytät loppuraporttiisi.

Aloittaaksesi ehdotuksen suunnittelun, muista perusmääritelmä: ehdotus on tarjous tai tarjous jonkun projektin toteuttamisesta. Ehdotukset voivat sisältää muitakin elementtejä – teknistä taustaa, suosituksia, tutkimustuloksia, tietoja toteutettavuudesta ja niin edelleen. Mutta ehdotuksen tekee ehdotuksesta ehdotuksen se, että siinä pyydetään yleisöä hyväksymään, rahoittamaan tai antamaan lupa ehdotetun hankkeen toteuttamiseen.

Ehdotuksen tulisi sisältää tietoja, joiden avulla ehdotuksen yleisö voi päättää, hyväksyykö se hankkeen, hyväksyykö se sinut tai palkkaako se sinut tekemään työn vai molempia. Jotta voisit kirjoittaa onnistuneen ehdotuksen, asetu yleisösi – ehdotuksen vastaanottajan – asemaan ja mieti, millaisia tietoja tämä henkilö tarvitsisi voidakseen luottaa siihen, että teet projektin.

Es on helppoa hämmentyä ehdotuksista tai ainakin sen tyyppisistä ehdotuksista, joita kirjoitat tätä kurssia varten. Kuvittele, että sinulla on loistava idea jonkin uuden tekniikan asentamiseksi työpaikallesi, ja kirjoitat asiakirjan, jossa selität, miten se toimii, esittelet sen hyödyt ja kehotat sitten johtoa asentamaan sen. Onko tämä ehdotus? Pelkästään se ei olisi täydellinen ehdotus. Se olisi pikemminkin toteutettavuusselvitys, jossa tutkitaan hankkeen ansioita ja suositellaan sitten sen puolesta tai sitä vastaan. Jotta tästä asiakirjasta tulisi ehdotus, siihen olisi kuitenkin lisättävä osia, joissa pyydetään johdon hyväksyntää hankkeen toteuttamiselle. Lisäksi tällä kurssilla yksi näistä elementeistä on tieteellinen tutkimus. Varmasti joidenkin ehdotusten laatijoiden on myytävä ehdottamiaan hankkeita, mutta kaikissa tapauksissa ehdotusten on myytävä laatijaa (tai laatijan organisaatiota) hankkeen toteuttajana.

Esitysten tyypit

Harkitse tilanteita, joissa ehdotuksia esiintyy. Yritys voi lähettää julkisen ilmoituksen, jossa pyydetään ehdotuksia tiettyä hanketta varten. Tämä julkinen ilmoitus, jota kutsutaan tarjouspyynnöksi (RFP), voidaan julkaista verkkosivustoilla, sähköpostitse, sosiaalisessa mediassa, sanomalehdissä tai ammattilehdissä. Hankkeesta kiinnostuneet yritykset tai yksityishenkilöt kirjoittaisivat tämän jälkeen ehdotuksia, joissa ne esittelevät yhteenvetona pätevyytensä, hankkeen aikataulut ja kustannukset sekä keskustelevat lähestymistavastaan hankkeeseen. Kaikkien näiden ehdotusten vastaanottaja arvioisi ne, valitsisi parhaan ehdokkaan ja laatisi sitten sopimuksen.

Mutta ehdotuksia syntyy myös paljon vähemmän muodollisesti. Kuvittele, että olet kiinnostunut tekemään projektin työpaikallasi (esimerkiksi tutkimaan jonkin uuden teknologian käyttöönoton etuja tuottavuuden lisäämiseksi). Kuvittele, että olet tavannut esimiehesi ja yrittänyt vakuuttaa hänet tästä. Hän saattaa vastata: ”Kirjoita minulle ehdotus, niin esittelen sen ylemmälle johdolle”. Tämä muistuttaa enemmänkin sellaista ehdotusta, jonka kirjoitat teknisen kirjoittamisen kurssilla.

Useimmat ehdotukset voidaan jakaa useisiin luokkiin:

  • Sisäiset, ulkoiset: Ehdotus jollekin organisaatiosi sisällä olevalle henkilölle (yritykselle, valtion virastolle jne.) on sisäinen ehdotus. Sisäisissä ehdotuksissa sinun ei välttämättä tarvitse sisällyttää niihin tiettyjä osioita (kuten pätevyysvaatimuksia) tai yhtä paljon tietoja. Ulkoinen ehdotus on ehdotus, jonka erillinen, riippumaton organisaatio tai henkilö on kirjoittanut toiselle vastaavalle taholle. Tyypillinen esimerkki on riippumaton konsultti, joka ehdottaa projektia toiselle yritykselle. Todennäköisesti kirjoitat jommankumman näistä kahdesta ehdotustyypistä tällä kurssilla, ja se voi olla pyydetty tai pyytämättä, kuten jäljempänä selitetään.
  • Pyydetty, pyytämättä: Pyydetty ehdotus on ehdotus, jonka vastaanottaja on pyytänyt ehdotusta. Tyypillisesti yritys lähettää tarjouspyynnöt (RFP) postitse tai julkaisee ne jossakin uutislähteessä. Ehdotuksia voidaan kuitenkin pyytää hyvinkin paikallisella tasolla: voit esimerkiksi selittää esimiehellesi, miten hienoa olisi asentaa toimistoon uusi teknologia; esimiehesi saattaa kiinnostua asiasta ja pyytää sinua laatimaan ehdotuksen, jossa tarjotaan virallisen tutkimuksen tekemistä ideasta. Tilaamattomat ehdotukset ovat ehdotuksia, joissa vastaanottaja ei ole pyytänyt ehdotuksia. Tilaamattomissa ehdotuksissa sinun on joskus vakuutettava vastaanottaja siitä, että ongelma tai tarve on olemassa, ennen kuin voit aloittaa ehdotuksen pääosan. Useimmat tällä kurssilla näkemämme teknisen kirjoittamisen projektit ovat olleet pyytämättömiä ehdotuksia.

Tyypillisiä skenaarioita ehdotukselle

Monet teistä eivät ehkä ole koskaan miettineet teknisen raportin laatimista toteuttamiskelpoisen ehdotuksen pohjalta. Tehtävänantolomakkeessa on useita esimerkkiaiheita; tässä muutamia lisäideoita:

  • Kuvittele, että yrityksellä on jokin ongelma tai se haluaa tehdä jonkinlaisen parannuksen. Yritys lähettää tarjouspyynnön; sinä saat sen ja vastaat siihen tekemällä ehdotuksen. Tarjoudut tulemaan paikalle, tutkimaan, haastattelemaan, tekemään suosituksia – ja esittämään kaiken tämän raportin muodossa.
  • Organisaatio haluaa seminaarin asiantuntemuksestasi. Kirjoitat ehdotuksen seminaarin pitämisestä – pakettisopimukseen sisältyy opas tai käsikirja, jonka seminaariin osallistujat saavat.
  • Virasto on juuri aloittanut uuden verkkotietojärjestelmän käytön, mutta käyttöopas on teknisesti monimutkainen ja vaikealukuinen. Saat tältä virastolta tarjouspyynnön yksinkertaisemman oppaan tai aloitusoppaan kirjoittamisesta.
  • Kuvittele, että tiettyyn asiaan keskittynyt voittoa tavoittelematon järjestö haluaa konsultin kirjoittamaan käsikirjan tai oppaan jäsenistölleen. Tässä asiakirjassa esitetään tietoa asiasta tavalla, jonka jäsenet voivat ymmärtää.

Eivät kaikki tutkimusaiheet sovellu tekniseen kirjoittamiseen. Aiheet, jotka perustuvat arvoihin ja uskomuksiin, eivät kuulu tekniseen kategoriaan. Historialliset ja kirjalliset aiheet eivät kelpaa. Kysy aina ohjaajaltasi kaikista aiheideoistasi ennen kuin aloitat projektin tekemisen.

Lisäksi muista, että sinun on sisällytettävä tieteellistä tutkimusta loppuraporttiisi, valitse aihe, josta voit helposti löytää tällaista aineistoa. Vaikka haastattelut ja muut omakohtaiset lähteet ovat usein arvokkaita raportin kannalta, raportti, joka tukeutuu pitkälti näihin lähteisiin, ei täytä tämän kurssin tavoitteita.

Yleisiä osioita ehdotuksissa

Seuraavassa on katsaus osioihin, joita tavallisesti löydät ehdotuksissa, jotka toimitetaan tällä kurssilla muistion muodossa. Älkää olettako, että jokaisen niistä on oltava kirjoittamassanne varsinaisessa ehdotuksessa tai että niiden on oltava tässä esitetyssä järjestyksessä. Tutustu tehtävänantolomakkeeseen ja pohdi muita aiheeseesi liittyviä ainutlaatuisia tietoja, jotka tulisi sisällyttää juuri sinun ehdotukseesi.

Lukiessasi tätä ehdotuksia käsittelevää lukua tutustu tämän viikon yksikkökansiossa jaettuun ehdotuksen muistion malliin. Muista jälleen, että kaikki tässä käsitellyt kohdat eivät näy esimerkeissä, mutta useimmat kyllä.

Esittely. Suunnittele ehdotuksesi johdanto huolellisesti. Varmista, että siinä tehdään kaikki seuraavat asiat (mutta ei välttämättä tässä järjestyksessä), jotka koskevat juuri sinun ehdotustasi:

  • Tiedota, että muistion sisältö on ehdotus tietystä hankkeesta.
  • Kehitä vähintään yksi lyhyt motivoiva lausuma, joka rohkaisee vastaanottajaa lukemaan eteenpäin ja harkitsemaan hankkeen hyväksymistä (erityisesti jos kyseessä on pyytämättä lähetetty tai kilpailutettu ehdotus).
  • Kerro ehdotuksen sisällöstä.

Tausta ongelmaan, mahdollisuuteen tai tilanteeseen. Usein heti johdannon jälkeen esiintyvässä taustaosiossa käsitellään sitä, mikä on aiheuttanut projektin tarpeen – mikä on ongelma, mikä on mahdollisuus asioiden parantamiseen, mikä on perustilanne. Esimerkiksi päiväkotiketjun johto voi joutua varmistamaan, että kaikki työntekijät osaavat elvytyksen, koska osavaltion uudet määräykset edellyttävät sitä, tai itäisessä Oregonissa sijaitsevan mäntypuuvaltaisen maa-alueen omistaja voi haluta saada maa-alueen tuottamaan myyntikelpoista puutavaraa tuhoamatta ympäristöä.

Vaikka ehdotuksen nimetty kohdeyleisö saattaa tuntea ongelman hyvin, taustaosion kirjoittaminen on hyödyllistä, koska se osoittaa oman näkemyksesi ongelmasta. Jos ehdotusta ei ole pyydetty, taustaosio on lähes pakollinen – sinun on luultavasti vakuutettava yleisö siitä, että ongelma tai mahdollisuus on olemassa ja että siihen olisi puututtava.

Ehdotetun hankkeen hyödyt ja toteutettavuus. Useimmissa ehdotuksissa käsitellään lyhyesti ehdotetun hankkeen toteuttamisen etuja tai hyötyjä. Tämä toimii eräänlaisena argumenttina hankkeen hyväksymisen puolesta. Joissakin ehdotuksissa käsitellään myös hankkeen onnistumisen todennäköisyyttä. Pyytämättä lähetetyssä ehdotuksessa tämä osio on erityisen tärkeä – yrität ”myydä” yleisölle projektin.

Kuvaus ehdotetusta työstä (projektin tulokset). Useimmissa ehdotuksissa on kuvattava ehdotetun hankkeen lopputuote. Teknisen kirjoittamisen kurssilla tämä tarkoittaa sitä, että kuvataan kirjallinen asiakirja, jonka kirjoittamista ehdotat, sen kohderyhmä ja tarkoitus; annetaan hahmotelma; ja keskustellaan esimerkiksi sen pituudesta, grafiikasta, sidonnasta ja niin edelleen. Määrittelemässäsi skenaariossa voi olla muitakin töitä, kuten koulutusseminaarien pitäminen tai jatkuvan palvelun tarjoaminen. Tässä alkuvaiheessa et ehkä vielä tiedä kaikkea, mitä projektisi toteuttaminen vaatii, mutta sinulla pitäisi ainakin olla käsitys joistakin tarvittavista vaiheista.

Metodi, menettelytapa, teoria. Joissakin ehdotuksissa sinun on selitettävä, miten aiot toteuttaa ehdotetun työn. Tämä toimii ylimääräisenä vakuuttavana elementtinä; se osoittaa yleisölle, että sinulla on vankka, harkittu lähestymistapa hankkeeseen. Lisäksi se osoittaa, että sinulla on riittävät tiedot alasta hankkeen toteuttamiseksi.

Aikataulu. Useimmissa ehdotuksissa on osio, josta käy ilmi suunnitellun valmistumispäivän lisäksi myös hankkeen keskeiset välitavoitteet. Jos olet tekemässä suurta hanketta, joka jakautuu usealle kuukaudelle, aikataulusta käy ilmi myös päivämäärät, jolloin toimitat edistymisraportteja. Jos et voi mainita tarkkoja päivämääriä, mainitse projektin kunkin vaiheen aikamäärät.

Kustannukset, tarvittavat resurssit. Useimmissa ehdotuksissa on myös kohta, jossa eritellään hankkeen kustannukset, olivatpa ne sitten sisäisiä tai ulkoisia. Ulkoisissa hankkeissa sinun on ehkä lueteltava tuntihintasi, ennakoidut työtunnit, laite- ja tarvikekustannukset jne. ja laskettava sitten koko hankkeen kokonaiskustannukset. Sisäiset projektit eivät tietenkään ole ilmaisia, joten sinun on silti lueteltava projektin kustannukset: projektin toteuttamiseen tarvitsemasi tunnit, käyttämäsi laitteet ja tarvikkeet, organisaation muiden henkilöiden apu ja niin edelleen.

Johtopäätökset. Ehdotuksen viimeisen kappaleen tai jakson tulisi palauttaa lukijat keskittymään hankkeen myönteisiin puoliin. Loppuosassa voit kehottaa heitä ottamaan yhteyttä sinuun hankkeen yksityiskohtien selvittämiseksi, muistuttaa heitä hankkeen toteuttamisen hyödyistä ja ehkä esittää vielä viimeisen argumentin sen puolesta, että sinä tai organisaatiosi on oikea valinta hankkeeseen.

Erityiset hankekohtaiset osiot. Muista, että edelliset osiot ovat tyypillisiä tai yleisiä kirjallisissa ehdotuksissa, eivät ehdottomia vaatimuksia. Kysy aina itseltäsi, mitä muuta yleisösi saattaisi tarvita ymmärtääkseen hankkeen, sen tarpeen, siitä koituvat hyödyt, sinun roolisi siinä ja pätevyytesi sen toteuttamiseen. Mitä muuta heidän on nähtävä, jotta he voivat hyväksyä hankkeen ja hyväksyä sinut sen toteuttamiseen?

Erikoistehtävän vaatimukset

Kirjoitustilanteesta riippuen ehdotuksessasi on ehkä oltava muitakin erikoistuneita osia. Joitakin näistä kuvataan jäljempänä. Huomaa: osa näistä elementeistä vaaditaan itse asiassa tämän kurssin edistymismuistiossasi; todellisessa teknisen kirjoittamisen tilanteessa ohjaajasi saattaa kuitenkin pyytää sinua sisällyttämään ehdotukseesi jotain seuraavista:

Audience: Kuvaile loppuraportin yleisö (joka voi olla eri kuin ehdotuksen yleisö). Saatat joutua keskustelemaan siitä, kenelle raportti on tarkoitettu, heidän nimikkeistään ja työtehtävistään, teknisestä taustastaan ja kyvystään ymmärtää raporttia.

Tietolähteet: Luettele tietolähteet; varmista, että tiedät, että aiheesta on riittävästi tietoa; luetteloi viittaukset tiettyihin kirjoihin, artikkeleihin, hakuteoksiin ja muunlaisiin lähteisiin, joiden uskot edistävän raporttiasi.

Grafiikka: Luettele grafiikat, joita uskot raporttisi tarvitsevan, niiden tyypin ja sisällön mukaan. (Jos et keksi yhtään sellaista, jota raporttisi tarvitsisi, sinulla ei ehkä ole hyvää aihetta – tee aivoriihi ohjaajasi kanssa). Tällä kurssilla sinun tulee luoda ja sisällyttää grafiikkaa loppuraporttiisi.

Outline: Liitä mukaan hahmotelma aiheista ja alateemoista, joita uskot käsitteleväsi raportissasi.

Esitykset ja yleisö

Muista, että teknisen kirjoittamisen kurssilla esitystehtävällä on useita tarkoituksia: (1) se antaa sinulle kokemusta ehdotuksen kirjoittamisesta; (2) se saa sinut aloittamaan lukukausiraporttisi suunnittelun; (3) se antaa opettajallesi mahdollisuuden työskennellä kanssasi projektin parissa varmistaakseen, että sinulla on toteuttamiskelpoinen aihe. Toisen ja kolmannen syyn vuoksi sinun on sisällytettävä ehdotukseesi tiettyjä elementtejä (jotka mainitaan tehtävänantolomakkeessasi), joista osa ei ehkä tunnu sopivalta todellisessa ehdotuksessa.

Tällä teknisen kirjoittamisen kurssilla ehdotus on alku viikkoja kestävälle tutkimus- ja kirjoitusprosessille, joka käy läpi monia vaiheita, kunnes päädytään loppupisteeseen: tekniseen raporttiin. Ehdotuksen lähetät tämän prosessin aikana vain kerran. Sen jälkeen kirjoitat ja toimitat erityyppisiä asiakirjoja: väliraportin, hahmotelman, kommentoidun kirjallisuusluettelon, graafisen luonnoksen, raporttiluonnoksen ja loppuraportin. Varo käyttämästä termiä ”ehdotus” vain, jos viittaat nimenomaan projektisi alkuvaiheeseen.

Toinen seikka, joka on syytä pitää mielessä, liittyy ehdotusten yleisöön verrattuna raporttien yleisöön, jotka tulevat myöhemmin kirjoitusprosessin aikana. Ehdotuksesi yleisö on henkilö, joka voi hyväksyä, tukea ja mahdollisesti rahoittaa tutkimuksesi ja kirjoituksesi. Lopullinen raportti, jonka tuotat, voi olla suunnattu eri yleisölle. Esimerkkinä on ehdotus, joka on kirjoitettu aurinkoenergiayhtiön esimiehelle ja jossa ehdotetaan toimintakäsikirjan laatimista kotitalouksien aurinkopaneeliasentajille. Ehdotuksen kohderyhmänä voi olla johtohenkilö, jonka tekninen tietämys voi olla hyvin laaja. Toisaalta loppuraportin kohderyhmänä ovat teknikot, joilla saattaa olla enemmän erikoistietoa kuin johtajalla. Näille kahdelle eri yleisölle suunnattua sisältöä ja kieltä on mukautettava kirjoitustilanteeseen sopivaksi. (Lisätietoja tästä on luvussa Yleisöanalyysi.)

Tarkistuslista ehdotusten tarkistamiseen

Kun tarkistat ja tarkistat ehdotustasi, pidä seuraavat asiat mielessä:

  • Käytä oikeaa muotoa. Muista, että tätä kurssia varten kirjoitat ehdotuksen muistion muotoon.
  • Kirjoita selkeä yhteenveto (tai johdanto) ehdotuksesi aiheesta.
  • Tunnista tarkalleen, mitä ehdotat tekeväsi.
  • Varmista, että raportti – kirjallinen dokumentti – liittyy jollakin tavalla ehdottamaasi hankkeeseen. Muista, että tällä teknisen kirjoittamisen kurssilla harjoittelemme sekä reaalimaailmassa tehtyjen ehdotusten kaltaisen ehdotuksen kirjoittamista että korkeakoulutasoisen tutkimusprojektin suorittamista.
  • Varmista, että ehdotuksesi osiot ovat loogisessa, luonnollisessa järjestyksessä ja että käytät väliotsikoita ja bulletteja (ja muita muotoilutyylejä) oikein.
  • Suuntaudu ehdotuksessasi nimettyyn kohderyhmääsi – etkä kouluttajaasi varten.

Luvun nimeämistiedot

Vastaa

Sähköpostiosoitettasi ei julkaista.