Tjenester for teknisk dokumentasjon
Tjenester for teknisk dokumentasjon for programvareselskaper: API-referanser, utviklerveiledninger, brukerdokumentasjon, runbooks og utgivelsesnotater, skrevet som kode ved siden av produktet og holdt oppdatert ved hver utgivelse.
Dette gjør tekniske skribenter hos oss
API-dokumentasjon
Referanse generert fra OpenAPI- eller GraphQL-skjemaet deres, med kom-i-gang-veiledninger, gjennomganger av autentisering og kjørbare eksempler skrevet rundt den, slik at referansen aldri redigeres for hånd.
Dokumentasjon som kode
Dokumentasjon i Markdown i kodelageret deres, gjennomgått i pull requests som kode og publisert med Docusaurus, Starlight eller en lignende generator av samme pipeline som produktet.
Brukerveiledninger og hjelpesentre
Oppgavebaserte veiledninger og artikler i hjelpesenteret organisert etter hva leseren prøver å gjøre, delt i opplæring, veiledninger for hvordan man gjør noe, referanse og forklaring etter Diátaxis-rammeverket.
Runbooks og driftsveiledninger
Trinnvise prosedyrer for utrullinger, gjenoppretting, hendelseshåndtering og vakt, testet av noen som ikke skrev dem.
Utgivelsesnotater og endringslogger
Utgivelsesnotater som forteller brukerne hva som endret seg for dem, og endringslogger for integratorer, utarbeidet fra sammenslåtte pull requests og kontrollert mot utgivelsen.
Kontroller av stil og kvalitet
En stilguide og en terminologiliste som Vale håndhever i pipelinen, med kontroll av ødelagte lenker ved hvert bygg, slik at konsistensen ikke avhenger av én enkelt gjennomleser.
Lei inn tekniske skribenter
På heltid i teamet deres
Tekniske skribenter som jobber i arbeidstiden deres, i verktøyene og møtene deres, og rapporterer til lederen deres, mens den ukrainske kontrakten, lønn og fravær ligger hos oss.
Deltid eller delvis engasjement
Tekniske skribenter et fast antall dager i uken, når arbeidet er reelt, men ennå ikke en heltidsrolle.
For et prosjekt eller en lansering
Tekniske skribenter for en avgrenset periode med arbeid, fra første uke til overleveringen, med sluttdato avtalt på forhånd.
Siden om dedikert team forklarer hvordan spesialister blir med i teamet deres, og siden om outsourcing dekker prosjektleveranse, overtakelser og hvordan vi priser.
Hvem tekniske skribenter hos oss samarbeider med
Utviklere og tekniske ledere
Intervjuer, gjennomganger og teknisk nøyaktighet
Produktsjefer
Funksjoner, målgrupper og omfanget av utgivelsen
Supportingeniører
Spørsmålene brukerne faktisk stiller
UI- og UX-designere
Tekster i brukergrensesnittet og diagrammer
Slik jobber våre tekniske skribenter
Dokumentasjonen ligger der koden ligger: i repositoriet, gjennomgått i samme pull request som endringen den beskriver, og bygget og publisert av pipelinen. En funksjon er ferdig når dokumentasjonen er merget, og det holder dokumentasjonen like oppdatert som koden.
Skrivingen starter hos leseren: hvem de er, hva de prøver å gjøre og hva de allerede kan. Supportsaker og søkeord viser hvor dagens dokumentasjon svikter, og de sidene rettes først.
Andre roller vi bemanner
Prosjektledere
Prosjektledelse for programvareleveranser: IT-prosjektledere og leveranseledere som har ansvar for planer, omfang, risikoer, budsjetter og ukentlig rapportering, på heltid i teamet deres, på deltid eller for ett enkelt prosjekt.
Forretningsanalytikere
Forretningsanalyse for programvareprosjekter: discovery, krav, user stories, BPMN-prosesskart og akseptkriterier, fra forretningsanalytikere på heltid i teamet deres, på deltid eller for et prosjekt.
Produktsjefer
Produktledelse for programvareprodukter: produktledere og produktansvarlige for discovery, roadmaps, backlogs og produktmetrikker, på heltid i teamet deres, noen dager i uken eller for en lansering.
Scrum masters
Scrum masters og agile coaching for programvareteam: Scrum og Kanban, flytmetrikker, hindringer som fjernes og retrospektiver som endrer noe, på heltid i teamet deres, på deltid eller for en avgrenset periode.
Teknisk support
Teknisk support for programvareprodukter: supportingeniører på første og andre linje i helpdesken deres, under deres merkevare og i kundenes åpningstider, på heltid, på deltid eller for en lansering.
IT-rekruttering
IT-rekruttering for selskaper som bygger egne team: rollebeskrivelser, sourcing, screening og tekniske intervjuer av utviklere som selv jobber i faget, fra IT-rekrutterere i teamet deres eller for en rekrutteringsrunde.
Customer success
Customer success management for SaaS- og abonnementsprodukter: customer success managers for onboarding, adopsjon, health scores, QBR-er og fornyelser, på heltid i teamet deres, på deltid eller for en lansering.
Spørsmål om å lei inn tekniske skribenter
Kan en teknisk skribent dokumentere et system som ingen har dokumentert?
Ja. Skribenten leser koden og konfigurasjonen, intervjuer utviklerne og lager en arkitekturoversikt, runbooks og en ordliste, som gjennomgås av dem som driver systemet. Det er det samme første trinnet, med kun lesetilgang, som våre overtakelser av arvede systemer starter med.
Hvordan holder dere API-dokumentasjonen i takt med API-et?
Referansen genereres fra OpenAPI- eller GraphQL-skjemaet ved hvert bygg, så den kan ikke komme ut av takt med API-et. Skribenten legger til det en generator ikke kan: kom-i-gang-guiden, gjennomgangen av autentisering og eksemplene en utvikler trenger før referansen blir nyttig.
Hvor raskt kan tekniske skribenter starte?
Når rett teknisk skribent er tilgjengelig, avhenger starten bare av intervjuet deres, NDA-en og IP-overdragelsen. Ellers gjennomfører vi et søk, som vanligvis gir kandidatprofiler innen to til tre uker, og ingen starter før dere har sagt ja.
Hvordan leier vi inn tekniske skribenter gjennom BigTree108?
Fortell oss om arbeidet, erfaringsnivået og timene dere trenger. Vi foreslår én eller to personer med profilene deres, dere intervjuer dem slik dere ville intervjuet en egen ansatt, og dere signerer én avtale med BIG TREE 108 LLC og får én faktura i måneden.
Hvem eier arbeidet de leverer?
Det gjør dere. Hver spesialist har en signert kontrakt med BigTree108 som overdrar alt arbeidsresultat til selskapet, og avtalen vår med dere overdrar det videre til dere. Kode, design og dokumenter leveres inn i deres egne repositorier og verktøy, og oppbevares ikke der bare vi kan endre dem.
Henger dokumentasjonen deres etter produktet?
Fortell oss om produktet, leserne og hvor dokumentasjonen ligger i dag. Dere får svar innen én arbeidsdag: kandidatprofiler eller en dokumentasjonsplan.