around February 2012, I was headed into a final interview for a technical writing role at an energy company. Minulla ei ollut aiempaa kokemusta energiateollisuudesta, joten arvelin, että siitä puhutaan jossain vaiheessa haastattelua.

yllättäen Haastattelu sujui melko hyvin, ja haastattelun loppupuolella, kun haastattelijat pyysivät nähdä näytteitä aiemmista töistäni, ojensin heille CD: n, johon olin huolellisesti kuratoinut joitakin aikaisempia työnäytteitäni ja jossa oli editoituja osia asiakkaan arkaluontoisten tietojen suojaamiseksi. Näytteet kattoivat 2-3 aiempaa projektiani, jotta saisin tarpeeksi ymmärrystä siitä, millaista työtä olin tehnyt energiateollisuuden ulkopuolella.

24 tuntia myöhemmin sain puhelun, että olin saanut roolin, ja iso osa tuosta päätöksestä tuli CD: llä esitettyihin työnäytteisiin. Palaute oli, että he olivat vaikuttuneita työn laadusta ja itse CD-levyn ideasta!

pointti on, että se vain lisäsi uskottavuutta siihen, että tekninen kirjoitussalkku on painonsa arvoinen kullassa. Hyvä portfolio lisää lopullisen kukoistaa tekninen kirjoittaminen kokemus.

tämä blogikirjoitus kattaa joitain ideoita teknisen kirjoitussalkun rakentamisesta sekä viimeaikaisen henkilökohtaisen kokemukseni portfolion rakentamisesta käyttäen markdownin, Gitin ja staattisen sivuston generaattorin yhdistelmää.

salkun rakentaminen

salkun rakentamista voi lähestyä muutamalla tavalla.

  • voit tulostaa joitakin parhaita töitäsi ja kantaa haastatteluihin kansiota, jonka avulla haastattelijat voivat käydä läpi näitä näytteitä.
    • tämän etuna on, että mukana voi kantaa työnäytteitä, jotka eivät ole julkisesti saatavilla, mutta jotka liittyvät suoraan siihen tehtävään, jota hakee.
    • varoituksen sana kuitenkin: suojellaksesi asiakkaan arkaluonteista ja tekijänoikeuksin suojattua/IP-materiaalia, sinun tulisi muuttaa näiden näytteiden asiaankuuluvia osia.
  • voit valita jaettavan asiakirjan, joka kuratoi osan tekemästäsi työstä ja on yleisemmin saatavilla julkisesti verkossa.
    • yksi etu tässä on se, että se mahdollistaa otosten sovittamisen tai muokkaamisen roolivaatimusten mukaan.
    • voit myös ohjata haastattelijat johonkin, mikä on helposti saatavilla verkossa.
  • sinulla voi olla oma verkkosivusto, joka korostaa kirjoittamistasi, sekä liuta muita taitoja suoraan, kuten tietoarkkitehtuuri, navigointi, sisällön organisointi ja suunnittelun ymmärtäminen.
    • tämän etuna on se, että se tarjoaa yhtenäisen rakenteen kirjoituskokemukseesi ja tarjoaa kurkistuksen suunnittelutaitoihisi.
    • yksi tämän haittapuolista on se, että sinun on investoitava aikaa sivuston luomiseen, kuratointiin ja ylläpitoon johdonmukaisesti, jotta pysyt kasvaneen kokemuksesi tasalla.

mitä salkkuun

kuuluu, Internetissä on jo aika paljon resursseja, jotka kattavat tämän hyvin yksityiskohtaisesti:

teknisen kirjoittamisen portfolion rakentaminen

(https://clickhelp.com/clickhelp-technical-writing-blog/how-to-build-a-technical-writing-portfolio/)

kokoa salkku

(https://idratherbewriting.com/2009/12/21/get-a-job-in-technical-writing-step-4-put-together-a-portfolio/)

teknisenä kirjoittajana olisin innokas laittamaan parhaan jalan eteenpäin, joten nämä asiat olisivat ehdottomasti listani kärjessä:

  • 5-6 parhaista työnäytteistäni, eri dokumentaatiotyypeissä, kuten käyttöoppaissa, online-ohjeissa, prosessi/työohjeissa, API: ssa ja kehittäjän dokumentaatiossa jne.
  • Tausta, konteksti ja lähestymistapasi dokumentaation ja dokumenttien luomiseen käytettyjen työkalujen luomisessa
  • yhteenveto kaikista avoimen lähdekoodin tai freelanceriprojekteista, joita työstettiin
  • kaikista esitelmistä, artikkeleista tai blogikirjoituksista, jotka on toimitettu ja julkaistu.

nykyinen salkkuni

joskus viime vuonna aloin työstää salkkuni (https://swapnilogale.github.io) päivittämistä jaettavasta asiakirjasta, jossa oli lista linkeistä omalle verkkosivustolle. Tarkoitus oli kaksijakoinen:

  • ensinnäkin se antoi minulle mahdollisuuden soveltaa rakennetta kasvavaan työnäytteiden luetteloon
  • toiseksi se antoi minulle mahdollisuuden oppia, poimia ja kiillottaa taitojani uudella dokumentointityökaluketjulla-Hugo static site generator (käyttäen Markdownia sisällön luomiseen), Git repos (koodin ja tuotosten tallentamiseen) ja GitHub portfolioni julkaisemiseen.

kun aloin rakentaa portfoliotani, tajusin myös, että tämä oli erinomainen tilaisuus käyttää joitakin sisältöstrategian käsitteitä, kuten tietoarkkitehtuuria, navigointia, substanssia ja rakennetta, näyttääkseni taitojani.

Hugon, Gitin ja GitHubin käyttäminen

minulla oli aikaisempaa kokemusta markdownin kanssa työskentelystä muutamissa aiemmissa projekteissani, mutta olin innokas kokeilemaan staattista sivustogeneraattoria tähän harjoitukseen. Valitsin Hugon (https://gohugo.io). Hugon dokumentoinnin jälkeen valitsin Hugon Ansioluetteloteeman (https://themes.gohugo.io/hugo-resume/) ja leikittelin sillä.

osa alkuesteistä kiersi:

  • Markdown-editorin perustaminen (työskentelen yleensä atomin kanssa),
  • pääni kiertäminen arkkityyppien käsitteelle (lähinnä mallipohjat), ja
  • kasvaminen mukavaksi Hugo Enginen itsensä toteuttavan luonteen kanssa, kun luot sisältöä sivustolle.

loin myös erilliset arkistot GitHubiin; toinen tallentaa koodini ja dokumenttini ja toinen tallentaa Tulostiedostot.

kun ympäristö oli perustettu, laadin suunnitelman sisällöstä, jonka halusin mukaan, ja keräsin tarvittavat resurssit (kuvat, linkit jne.) sivustolle.

työskennellessäni Hugon dokumentaation (https://gohugo.io/documentation/) kautta onnistuin luomaan luonnoksen salkusta, johon olin suhteellisen tyytyväinen. Seuraava askel oli työntää nämä muutokset GitHub-arkistoon ja ylläpitää sitä GitHub-sivuilla.

(ollakseni rehellinen, olin alun perin suunnitellut juontavani tätä Netlifyssä, mutta tunsin oloni turvalliseksi Githubin ympäristössä, joten päätin lähteä mukaan).

työnsin luonnoksen Githubin sivuille ja salkku oli käytännössä valmis.

katsauksia ja hienosäätöä

yksikään tekninen asiakirja ei ole koskaan valmis ilman tarkistusta. Going tämän sanonnan, päätin testata tätä portfolio saamalla muutaman muiden teknisten kirjailijoiden minun network tarkistaa tämän. Tarkoituksellisesti päätin pyytää poikkileikkaus tech kirjoittajat, mukaan lukien tekninen kirjoittaminen johtajat tarkastella tätä eri näkökulmista.

kun he olivat arvostelleet tätä ja antaneet todella rakentavaa palautetta, pystyin hienosäätämään portfolion sisällön ja jakamaan sen luottavaisesti isommalle yleisölle.

katsaukset, jotka ovat usein hyödyllisiä, jäävät usein teknisessä dokumentaatiossa liian vähälle huomiolle. Toisen silmäparin tarkasteleminen salkkuun eri linssien kautta on tehnyt salkusta johdonmukaisemman ja vähemmän virhealtista.

jatkuva ylläpito

kuten monet tekniset asiakirjat, portfolio ei ole koskaan 100% täydellinen. Tulee olemaan lukuisia tapauksia, kun olet lisäämällä tai päivittämällä tämän sivuston. Jatkuvan ylläpidon tulisi näkyä myös suunnitelmissasi, jos haluat pitää yllä portfoliosi verkkoversiota.

Loppuhuomautukset

portfolion työstäminen oli hieno kokemus, erityisesti yritettiin oppia doc-työkalujen sisäiset mekanismit ja luoda toimiva doc-työnkulku.

  • portfolio on loistava tapa esitellä paitsi taitojasi, kokemustasi ja työsi parhaita puolia, myös mahdollisuus esitellä ajatusprosessiasi ja kokemuksesi tuloksia.
  • pidä se yksinkertaisena. Teknisen kirjoitussalkun ideana on esitellä kirjoituskylttejäsi ja sitä, miten lähestyt erilaisia dokumentointiprojekteja.
  • älä aliarvioi avoimen lähdekoodin saavutusten esittelyn tärkeyttä. Näillä on huomattava valuutta ohjelmistoprojekteissa kuin kuvittelet.

tietoa tekijästä

Swapnil Ogale
Swapnil on Tekninen kirjoittaja, jolla on lähes 14 vuoden kokemus eri aloilta Australiassa ja maailmanlaajuisesti. Hän aloitti Write the Docs-yhteisön Australiassa vuonna 2016 ja on ollut järjestämässä paikallisia meetupeja sekä vuosittaista kansallista konferenssia. Swapnil rakastaa matkustamista, lukemista, kirjoittamista (kyllä, hän kirjoittaa myös päivätyönsä ulkopuolella), ja hän on foodie.
kun hän ei tee mitään, hän esittelee teknisissä tapaamisissa ja konferensseissa erilaisia aiheita teknisen kirjoittamisen ympärillä. Hänen intohimoistaan voi lukea lisää LinkedInistä ja Twitteristä.

Vastaa

Sähköpostiosoitettasi ei julkaista.