Teknisk dokumentation
Teknisk dokumentation til softwarevirksomheder: API-referencer, udviklerguides, brugerdokumentation, runbooks og release notes, skrevet som kode ved siden af produktet og holdt ajour ved hver udgivelse.
Det laver vores tekniske skribenter
API-dokumentation
Reference genereret ud fra jeres OpenAPI- eller GraphQL-skema, med kom-i-gang-guides, gennemgange af autentificering og kørbare eksempler skrevet omkring den, så referencen aldrig redigeres i hånden.
Docs as code
Dokumentation i Markdown i jeres repository, gennemgået i pull requests som kode og udgivet med Docusaurus, Starlight eller en lignende generator af den samme pipeline som produktet.
Brugerguides og hjælpecentre
Opgavebaserede guides og artikler til hjælpecentre organiseret efter, hvad læseren forsøger at gøre, delt i tutorials, how-to-guides, reference og forklaring efter Diátaxis-frameworket.
Runbooks og driftsguides
Trin-for-trin-procedurer til udrulninger, gendannelser, hændelsesrespons og vagtberedskab, testet af en, der ikke har skrevet dem.
Release notes og changelogs
Release notes, der fortæller brugerne, hvad der er ændret for dem, og changelogs til integratorer, udarbejdet ud fra merged pull requests og kontrolleret mod udgivelsen.
Kontrol af stil og kvalitet
En stilguide og en terminologiliste, som Vale håndhæver i pipelinen, og kontrol af døde links ved hvert build, så ensartetheden ikke afhænger af én enkelt reviewer.
Ansæt tekniske skribenter
På fuld tid i jeres team
Tekniske skribenter, der arbejder i jeres arbejdstid i jeres værktøjer og møder og rapporterer til jeres leder, mens den ukrainske kontrakt, lønnen og ferie og orlov ligger hos os.
Deltid eller fractional
Tekniske skribenter et fast antal dage om ugen, når arbejdet er reelt, men endnu ikke en fuldtidsrolle.
Til et projekt eller en lancering
Tekniske skribenter til en afgrænset arbejdsperiode, fra første uge til overdragelsen, med slutdatoen aftalt på forhånd.
Siden om dedikerede teams forklarer, hvordan specialister indgår i jeres team, og siden om outsourcing beskriver projektleverance, overtagelser og hvordan vi tager betaling.
Hvem vores tekniske skribenter arbejder sammen med
Udviklere og tekniske ledere
Interviews, review og teknisk korrekthed
Produktchefer
Funktioner, målgrupper og releaseomfang
Supportingeniører
De spørgsmål, brugerne faktisk stiller
UI- og UX-designere
Tekster i brugerfladen og diagrammer
Sådan arbejder vores tekniske skribenter
Dokumentationen bor, hvor koden bor: i repositoriet, gennemgået i samme pull request som den ændring, den beskriver, og bygget og udgivet af pipelinen. En funktion er færdig, når dens dokumentation er merget, og det holder dokumentationen lige så ajour som koden.
Skrivningen tager udgangspunkt i læseren: hvem de er, hvad de vil opnå, og hvad de allerede ved. Supporttickets og søgetermer viser, hvor den nuværende dokumentation svigter, og de sider rettes først.
Andre roller, vi bemander
Projektledere
Projektledelse af softwareleverancer: IT-projektledere og delivery managers, der ejer planer, scope, risici, budgetter og ugentlig rapportering, på fuld tid i jeres team, på deltid eller til ét enkelt projekt.
Forretningsanalytikere
Forretningsanalyse til softwareprojekter: discovery, krav, user stories, BPMN-procesdiagrammer og acceptkriterier, fra forretningsanalytikere på fuld tid i jeres team, på deltid eller til et projekt.
Product managers
Produktledelse af softwareprodukter: product managers og product owners til discovery, roadmaps, backlogs og produktmetrikker, på fuld tid i jeres team, nogle dage om ugen eller til en lancering.
Scrum masters
Scrum masters og agil coaching til softwareteams: Scrum og Kanban, flowmetrikker, fjernede hindringer og retrospektiver, der ændrer noget, på fuld tid i jeres team, på deltid eller i en afgrænset periode.
Teknisk support
Teknisk support til softwareprodukter: supportingeniører på første og anden linje i jeres helpdesk, under jeres brand og i jeres kunders åbningstider, på fuld tid, på deltid eller til en lancering.
IT-rekruttering
IT-rekruttering for virksomheder, der bygger deres egne teams: rollebeskrivelser, sourcing, screening og tekniske interviews ved praktiserende ingeniører, fra IT-rekrutterere i jeres team eller til en ansættelsesrunde.
Customer success
Customer success management til SaaS- og abonnementsprodukter: customer success managers til onboarding, adoption, health scores, QBR'er og fornyelser, på fuld tid i jeres team, på deltid eller til en lancering.
Spørgsmål om ansættelse af tekniske skribenter
Kan en teknisk skribent dokumentere et system, som ingen har dokumenteret?
Ja. Skribenten læser koden og konfigurationen, interviewer udviklerne og udarbejder en arkitekturoversigt, runbooks og en ordliste, som gennemgås af dem, der driver systemet. Det er det samme første, skrivebeskyttede trin, som vores overtagelser af arvede systemer starter med.
Hvordan holder I API-dokumentationen på linje med API'et?
Referencen genereres ud fra OpenAPI- eller GraphQL-skemaet i buildet og kan derfor ikke komme ud af trit med API'et. Skribenten tilføjer det, en generator ikke kan: kom-godt-i-gang-vejledningen, gennemgangen af autentificering og de eksempler, en udvikler har brug for, før referencen kan bruges.
Hvor hurtigt kan tekniske skribenter starte?
Når den rette teknisk skribent er tilgængelig, afhænger starten kun af jeres samtale samt NDA og overdragelse af IP-rettigheder. Ellers gennemfører vi en søgning, som typisk giver kandidatprofiler inden for to til tre uger, og ingen starter, før I har sagt ja.
Hvordan ansætter vi tekniske skribenter gennem BigTree108?
Fortæl os om opgaverne, erfaringsniveauet og det timetal, I har brug for. Vi foreslår en eller to personer med deres profiler, I interviewer dem på samme måde, som I ville interviewe jeres egen medarbejder, og I underskriver én aftale med BIG TREE 108 LLC og modtager én faktura om måneden.
Hvem ejer det arbejde, de producerer?
Det gør I. Hver specialist har en underskrevet kontrakt med BigTree108, som overdrager alt arbejdsresultat til virksomheden, og vores aftale med jer overdrager det videre til jer. Kode, designs og dokumenter leveres ind i jeres egne repositories og værktøjer og opbevares ikke et sted, hvor kun vi kan ændre dem.
Halter jeres dokumentation efter produktet?
Fortæl os om produktet, dets læsere, og hvor dokumentationen findes i dag. I får svar inden for én arbejdsdag: kandidatprofiler eller en dokumentationsplan.