Tjänster inom teknisk dokumentation
Teknisk dokumentation för mjukvaruföretag: API-referenser, utvecklarguider, användardokumentation, runbooks och release notes, skrivna som kod bredvid produkten och hållna aktuella vid varje release.
Vad våra tekniska skribenter gör
API-dokumentation
Referens som genereras från ert OpenAPI- eller GraphQL-schema, med kom-igång-guider, genomgångar av autentisering och körbara exempel skrivna runt den, så att referensen aldrig redigeras för hand.
Docs as code
Dokumentation i Markdown i ert kodförvar, granskad i pull requests som kod och publicerad med Docusaurus, Starlight eller en liknande generator av samma pipeline som produkten.
Användarguider och hjälpcenter
Uppgiftsbaserade guider och artiklar i hjälpcentret organiserade efter vad läsaren försöker göra, indelade i tutorials, how-to-guider, referens och förklaring enligt ramverket Diátaxis.
Runbooks och driftguider
Steg-för-steg-rutiner för driftsättningar, återställningar, incidenthantering och jour, testade av någon som inte skrev dem.
Release notes och ändringsloggar
Release notes som berättar för användarna vad som ändrats för dem, och ändringsloggar för integratörer, utkastade från mergade pull requests och kontrollerade mot releasen.
Stil- och kvalitetskontroller
En stilguide och en termlista som Vale driver igenom i pipelinen, med kontroll av trasiga länkar vid varje bygge, så att enhetligheten inte hänger på en enskild granskare.
Anlita tekniska skribenter
På heltid i ert team
Tekniska skribenter som arbetar på era tider i era verktyg och möten och rapporterar till er teamledare, med det ukrainska avtalet, lönen och ledigheten hos oss.
På deltid eller fraktionellt
Tekniska skribenter ett bestämt antal dagar i veckan, när arbetet är verkligt men ännu inte en heltidsroll.
För ett projekt eller en lansering
Tekniska skribenter för en avgränsad period, från första veckan till överlämningen, med slutdatum överenskommet i förväg.
Sidan om dedikerade team förklarar hur specialister går med i ert team, och sidan om outsourcing beskriver projektleverans, övertaganden och hur vi debiterar.
Vilka våra tekniska skribenter arbetar med
Ingenjörer och tekniska ledare
Intervjuer, granskning och teknisk korrekthet
Produktchefer
Funktioner, målgrupper och releaseomfång
Supporttekniker
De frågor användarna faktiskt ställer
UI- och UX-designers
Gränssnittstexter och diagram
Så arbetar våra tekniska skribenter
Dokumentationen finns där koden finns: i repositoryt, granskad i samma pull request som ändringen den beskriver, och byggd och publicerad av pipelinen. En funktion är klar när dokumentationen har mergats, och det håller dokumentationen lika aktuell som koden.
Skrivandet utgår från läsarna: vilka de är, vad de försöker åstadkomma och vad de redan kan. Supportärenden och sökord visar var dagens dokumentation brister, och just de sidorna rättas först.
Andra roller vi bemannar
Projektledare
Projektledning för mjukvaruleveranser: IT-projektledare och leveransansvariga som äger planer, omfattning, risker, budgetar och veckorapportering, på heltid i ert team, på deltid eller för ett enskilt projekt.
Affärsanalytiker
Affärsanalys för mjukvaruprojekt: förstudie, krav, user stories, processkartor i BPMN och acceptanskriterier, från affärsanalytiker på heltid i ert team, på deltid eller för ett projekt.
Produktchefer
Produktledning för mjukvaruprodukter: produktchefer och product owners för förstudie, roadmaps, backlogs och produktmått, på heltid i ert team, ett par dagar i veckan eller för en lansering.
Scrum masters
Scrum masters och agil coachning för mjukvaruteam: Scrum och Kanban, flödesmått, hinder som undanröjs och retrospektiv som faktiskt ändrar något, på heltid i ert team, på deltid eller under en bestämd period.
Teknisk support
Tjänster inom teknisk support för mjukvaruprodukter: supporttekniker på första och andra linjen i er helpdesk, under ert varumärke och på era kunders tider, på heltid, på deltid eller för en lansering.
IT-rekrytering
Tjänster inom IT-rekrytering för bolag som bygger egna team: rollbeskrivningar, sourcing, screening och tekniska intervjuer av verksamma ingenjörer, från IT-rekryterare i ert team eller för en rekryteringsinsats.
Customer success
Customer success management för SaaS- och prenumerationsprodukter: customer success managers för onboarding, adoption, health scores, QBR:er och förnyelser, på heltid i ert team, på deltid eller för en lansering.
Frågor om att anlita tekniska skribenter
Kan en teknisk skribent dokumentera ett system som ingen har dokumenterat?
Ja. Skribenten läser koden och konfigurationen, intervjuar utvecklarna och tar fram en arkitekturöversikt, runbooks och en ordlista, granskade av dem som driver systemet. Det är samma skrivskyddade första steg som våra övertaganden av ärvda system börjar med.
Hur håller ni API-dokumentationen i takt med API:et?
Referensen genereras ur OpenAPI- eller GraphQL-schemat i bygget, så den kan inte glida ifrån API:et. Skribenten lägger till det en generator inte klarar: kom-igång-guiden, genomgången av autentiseringen och de exempel en utvecklare behöver innan referensen blir användbar.
Hur snabbt kan tekniska skribenter börja?
När rätt teknisk skribent finns tillgänglig styrs starten bara av er intervju samt NDA och IP-överlåtelse. Annars gör vi en sökning, som vanligtvis ger kandidatprofiler inom två till tre veckor, och ingen börjar förrän ni har sagt ja.
Hur anlitar vi tekniska skribenter via BigTree108?
Berätta om arbetet, senioriteten och de timmar ni behöver. Vi föreslår en eller två personer med deras profiler, ni intervjuar dem på samma sätt som ni skulle intervjua en egen anställning, och ni skriver under ett avtal med BIG TREE 108 LLC och får en faktura i månaden.
Vem äger arbetet de producerar?
Det gör ni. Varje specialist har ett undertecknat avtal med BigTree108 som överlåter allt arbetsresultat till bolaget, och vårt avtal med er överlåter det vidare. Kod, designer och dokument levereras in i era egna repositories och verktyg, inte på ett ställe där bara vi kan ändra dem.
Ligger er dokumentation efter produkten?
Berätta vilken produkt det gäller, vilka läsarna är och var dokumentationen finns i dag. Ni får svar inom en arbetsdag: kandidatprofiler eller en dokumentationsplan.