Teknisen kirjoittamisen palvelut
Teknisen kirjoittamisen palveluja ohjelmistoyrityksille: API-viitteet, kehittäjäoppaat, käyttäjädokumentaatio, runbookit ja julkaisutiedotteet, kirjoitettuina koodina tuotteen rinnalle ja pidettyinä ajan tasalla jokaisen julkaisun mukana.
Mitä meidän tekniset kirjoittajat tekevät
API-dokumentaatio
OpenAPI- tai GraphQL-skeemastanne generoitu viite, jonka ympärille kirjoitetaan aloitusoppaat, tunnistautumisen läpikäynnit ja ajettavat esimerkit, joten viitettä ei koskaan muokata käsin.
Docs as code
Dokumentaatio Markdownina repositoriossanne, katselmoituna pull requesteissa kuten koodi ja julkaistuna Docusaurus-, Starlight- tai vastaavalla generaattorilla samalla pipelinellä kuin tuote.
Käyttöoppaat ja ohjekeskukset
Tehtäväpohjaiset oppaat ja ohjekeskuksen artikkelit järjestettyinä sen mukaan, mitä lukija yrittää tehdä, jaettuna opetusohjelmiin, ohjeisiin (how-to), viitteeseen ja selityksiin Diátaxis-viitekehyksen mukaan.
Runbookit ja operointioppaat
Vaiheittaiset menettelyt käyttöönottoihin, palautuksiin, poikkeamavasteeseen ja päivystykseen, testattuna jonkun toimesta, joka ei kirjoittanut niitä.
Julkaisutiedotteet ja muutosloki
Julkaisutiedotteet, jotka kertovat käyttäjille, mikä muuttui heille, ja muutoslokit integroijille, luonnosteltuina yhdistetyistä pull requesteista ja tarkistettuina julkaisua vasten.
Tyyli- ja laatutarkistukset
Tyyliopas ja termistö, joita Vale valvoo CI/CD-putkessa, sekä rikkinäisten linkkien tarkistus jokaisessa buildissa, jotta johdonmukaisuus ei riipu yhdestä tarkastajasta.
Palkatkaa tekniset kirjoittajat
Kokoaikaisesti tiimissänne
Tekniset kirjoittajat työskentelevät teidän työajallanne teidän työkaluissanne ja palavereissanne ja raportoivat teidän vetäjällenne. Ukrainan sopimus, palkanmaksu ja lomat hoituvat meidän puolellamme.
Osa-aikaisesti tai osittaisella työpanoksella
Tekniset kirjoittajat sovittuna määränä päiviä viikossa silloin, kun työtä on mutta ei vielä kokoaikaisen roolin verran.
Projektiin tai lanseeraukseen
Tekniset kirjoittajat rajattuun työjaksoon ensimmäisestä viikosta luovutukseen, päättymispäivä sovittuna etukäteen.
Dedikoitu tiimi -sivu selittää, miten asiantuntijat liittyvät tiimiinne, ja ulkoistussivu kattaa projektitoimituksen, haltuunotot ja hinnoittelumme.
Keiden kanssa tekniset kirjoittajat työskentelevät
Insinöörit ja tekniset vetäjät
Haastattelut, katselmoinnit ja tekninen oikeellisuus
Tuotepäälliköt
Ominaisuudet, kohderyhmät ja julkaisun laajuus
Tukiasiantuntijat
Kysymykset, joita käyttäjät todella esittävät
UI- ja UX-suunnittelijat
Käyttöliittymätekstit ja kaaviot
Näin teknisten kirjoittajiemme työ etenee
Dokumentaatio sijaitsee siellä, missä koodikin: repositoriossa. Se katselmoidaan samassa pull requestissa kuin kuvaamansa muutos, ja putki rakentaa ja julkaisee sen. Ominaisuus on valmis, kun sen dokumentaatio on yhdistetty päähaaraan, minkä ansiosta dokumentaatio pysyy yhtä ajantasaisena kuin koodi.
Kirjoittaminen alkaa lukijasta: kuka hän on, mitä hän yrittää tehdä ja mitä hän jo tietää. Tukitiketit ja hakusanat osoittavat, missä nykyinen dokumentaatio ei toimi, ja nämä sivut korjataan ensin.
Muut tarjoamamme roolit
Projektipäälliköt
Projektinhallinta ohjelmistotoimituksiin: IT-projekti- ja toimituspäälliköt, jotka vastaavat suunnitelmista, laajuudesta, riskeistä, budjeteista ja viikoittaisesta raportoinnista, kokoaikaisesti tiimissänne, osa-aikaisesti tai yksittäiseen projektiin.
Liiketoiminta-analyytikot
Liiketoiminta-analyysi ohjelmistoprojekteihin: esiselvitys, vaatimukset, user storyt, BPMN-prosessikartat ja hyväksymiskriteerit liiketoiminta-analyytikoilta kokoaikaisesti tiimissänne, osa-aikaisesti tai projektiin.
Tuotepäälliköt
Tuotehallinta ohjelmistotuotteille: tuotepäälliköt ja product ownerit esiselvitykseen, tiekarttoihin, backlogeihin ja tuotemittareihin, kokoaikaisesti tiimissänne, muutamana päivänä viikossa tai lanseerausta varten.
Scrum Masterit
Scrum Masterit ja ketterä valmennus ohjelmistotiimeille: Scrum ja Kanban, virtausmittarit, esteiden poistaminen ja retrospektiivit, jotka muuttavat jotain, kokoaikaisesti tiimissänne, osa-aikaisesti tai määräajaksi.
Tekninen tuki
Teknisen tuen palvelut ohjelmistotuotteille: ensimmäisen ja toisen linjan tukiinsinöörit teidän helpdeskissänne, teidän brändinne alla ja asiakkaidenne aukioloaikoina, kokoaikaisesti, osa-aikaisesti tai lanseerausta varten.
IT-rekrytointi
IT-rekrytointipalvelut yrityksille, jotka rakentavat omia tiimejään: roolikuvaukset, hakeminen, seulonta ja työssä olevien insinöörien tekemät tekniset haastattelut IT-rekrytoijilta tiimissänne tai rekrytointiputkeen.
Asiakasmenestys
Asiakasmenestyksen johtaminen SaaS- ja tilaustuotteille: asiakasmenestysvastaavat perehdytykseen, käyttöönottoon, asiakkuuden terveyspisteisiin, QBR-tapaamisiin ja uusintoihin, kokoaikaisesti tiimissänne, osa-aikaisesti tai lanseerausta varten.
Kysymyksiä palkkaamisesta: tekniset kirjoittajat
Voiko tekninen kirjoittaja dokumentoida järjestelmän, jota kukaan ei ole dokumentoinut?
Kyllä. Kirjoittaja tutustuu koodiin ja konfiguraatioon, haastattelee kehittäjiä ja tuottaa arkkitehtuurikuvauksen, runbookit ja sanaston, jotka järjestelmää ylläpitävät ihmiset katselmoivat. Tämä on sama vain lukemiseen perustuva ensimmäinen vaihe, josta perittyjen järjestelmien haltuunottomme alkavat.
Miten pidätte API-dokumentaation synkassa API:n kanssa?
Viitedokumentaatio generoidaan buildissa OpenAPI- tai GraphQL-skeemasta, joten se ei voi erkaantua API:sta. Kirjoittaja lisää sen, mihin generaattori ei pysty: aloitusoppaan, todennuksen läpikäynnin ja esimerkit, joita kehittäjä tarvitsee, ennen kuin viitedokumentaatiosta on hyötyä.
Kuinka nopeasti tekniset kirjoittajat voivat aloittaa?
Kun sopiva tekninen kirjoittaja on saatavilla, aloitus riippuu vain teidän haastattelustanne sekä salassapitosopimuksesta (NDA) ja immateriaalioikeuksien siirrosta. Muussa tapauksessa teemme haun, joka tuottaa yleensä ehdokasprofiileja kahden tai kolmen viikon kuluessa, eikä kukaan aloita ennen kuin olette hyväksyneet.
Miten palkataan tekniset kirjoittajat BigTree108:n kautta?
Kertokaa meille työstä, kokemustasosta ja tarvitsemistanne tunneista. Ehdotamme yhtä tai kahta henkilöä profiileineen, te haastattelette heidät samoin kuin haastattelisitte oman rekrytointinne, ja allekirjoitatte yhden sopimuksen BIG TREE 108 LLC:n kanssa ja saatte yhden laskun kuukaudessa.
Kenelle heidän tuottamansa työ kuuluu?
Teille. Jokaisella asiantuntijalla on BigTree108:n kanssa allekirjoitettu sopimus, jossa kaikki työn tulokset siirretään yhtiölle, ja meidän sopimuksemme teidän kanssanne siirtää ne edelleen teille. Koodi, suunnitelmat ja dokumentit toimitetaan teidän omiin repositorioihinne ja työkaluihinne, eikä niitä säilytetä paikassa, jossa vain me voimme muuttaa niitä.
Onko dokumentaatio jäänyt tuotteesta jälkeen?
Kertokaa meille tuotteesta, sen lukijoista ja siitä, missä dokumentaatio nyt sijaitsee. Saatte vastauksen yhden arkipäivän kuluessa: ehdokasprofiileja tai dokumentaatiosuunnitelman.