Technisch schrijven
Technisch schrijven voor softwarebedrijven: API-referenties, ontwikkelaarshandleidingen, gebruikersdocumentatie, runbooks en release notes, als code naast het product geschreven en met elke release actueel gehouden.
Wat onze technisch schrijvers doen
API-documentatie
Referentie gegenereerd uit uw OpenAPI- of GraphQL-schema, met startgidsen, uitleg over authenticatie en uitvoerbare voorbeelden eromheen geschreven, zodat de referentie nooit met de hand wordt bewerkt.
Docs as code
Documentatie in Markdown in uw repository, als code gereviewd in pull requests en gepubliceerd met Docusaurus, Starlight of een vergelijkbare generator door dezelfde pijplijn als het product.
Gebruikershandleidingen en helpcentra
Taakgerichte handleidingen en artikelen voor het helpcentrum, geordend naar wat de lezer probeert te doen, opgedeeld in tutorials, how-to-gidsen, referentie en uitleg volgens het Diátaxis-framework.
Runbooks en beheerhandleidingen
Stapsgewijze procedures voor uitrol, herstel, incidentrespons en bereikbaarheidsdiensten, getest door iemand die ze niet heeft geschreven.
Release notes en changelogs
Release notes die gebruikers vertellen wat er voor hen is veranderd, en changelogs voor integrators, opgesteld uit samengevoegde pull requests en gecontroleerd tegen de release.
Controles op stijl en kwaliteit
Een stijlgids en terminologielijst die Vale in de pipeline afdwingt, met een controle op dode links bij elke build, zodat consistentie niet afhangt van één reviewer.
technisch schrijvers inhuren
Fulltime in uw team
Technisch schrijvers die uw uren werken, in uw tools en vergaderingen, aan uw lead rapporteren, met het Oekraïense contract, de salarisadministratie en het verlof aan onze kant.
Parttime of fractioneel
Technisch schrijvers voor een vast aantal dagen per week, wanneer het werk echt is maar nog geen fulltimerol vormt.
Voor een project of een lancering
Technisch schrijvers voor een afgebakende periode, van de eerste week tot de overdracht, met de einddatum vooraf afgesproken.
De pagina dedicated team legt uit hoe specialisten bij uw team komen, en de pagina outsourcing behandelt projectoplevering, overnames en hoe wij rekenen.
Met wie onze technisch schrijvers samenwerken
Engineers en technisch leiders
Interviews, reviews en technische juistheid
Productmanagers
Functies, doelgroepen en releasescope
Support engineers
De vragen die gebruikers echt stellen
UI- en UX-designers
Interfaceteksten en diagrammen
Hoe onze technical writers werken
Documentatie staat waar de code staat: in de repository, gereviewd in dezelfde pull request als de wijziging die zij beschrijft, en gebouwd en gepubliceerd door de pipeline. Een functie is af wanneer de documentatie is gemerged, zodat de documentatie net zo actueel blijft als de code.
Het schrijven begint bij de lezer: wie dat is, wat die wil bereiken en wat die al weet. Supporttickets en zoektermen laten zien waar de huidige documentatie tekortschiet, en die pagina’s worden als eerste verbeterd.
Andere rollen die wij invullen
Projectmanagers
Projectmanagement voor softwareoplevering: IT-project- en deliverymanagers die plannen, scope, risico’s, budgetten en wekelijkse rapportage beheren, fulltime in uw team, parttime of voor één project.
Business analysts
Businessanalyse voor softwareprojecten: discovery, eisen, user stories, BPMN-procesdiagrammen en acceptatiecriteria, van business analysts fulltime in uw team, parttime of voor een project.
Productmanagers
Productmanagement voor softwareproducten: productmanagers en product owners voor discovery, roadmaps, backlogs en productmetrics, fulltime in uw team, een paar dagen per week of voor een lancering.
Scrum masters
Scrum masters en agile coaching voor softwareteams: Scrum en Kanban, flowmetrics, het wegnemen van belemmeringen en retrospectives die iets veranderen, fulltime in uw team, parttime of voor een afgesproken periode.
Technische support
Diensten voor technische support van softwareproducten: eerstelijns- en tweedelijnssupportengineers in uw helpdesk, onder uw merk en binnen de uren van uw klanten, fulltime, parttime of voor een lancering.
IT-recruitment
IT-recruitmentdiensten voor bedrijven die hun eigen teams opbouwen: functieprofielen, sourcing, screening en technische interviews door werkende engineers, van IT-recruiters in uw team of voor een wervingsronde.
Customer success
Customer success management voor SaaS- en abonnementsproducten: customer success managers voor onboarding, adoptie, health scores, QBR’s en verlengingen, fulltime in uw team, parttime of voor een lancering.
Vragen over het inhuren van technisch schrijvers
Kan een technical writer een systeem documenteren dat nog nooit is gedocumenteerd?
Ja. De schrijver leest de code en de configuratie, interviewt de engineers en levert een architectuuroverzicht, runbooks en een woordenlijst op, die worden gereviewd door de mensen die het systeem beheren. Het is dezelfde eerste stap, uitsluitend lezen, waarmee onze overnames van geërfde systemen beginnen.
Hoe blijft de API-documentatie in de pas met de API?
De referentie wordt in de build gegenereerd uit het OpenAPI- of GraphQL-schema, zodat die niet van de API kan afwijken. De schrijver voegt toe wat een generator niet kan: de startersgids, de uitleg over authenticatie en de voorbeelden die een ontwikkelaar nodig heeft voordat de referentie bruikbaar is.
Hoe snel kunnen technisch schrijvers beginnen?
Als de juiste technisch schrijver beschikbaar is, hangt de start alleen af van uw interview en de NDA en IP-overdracht. Anders voeren wij een zoektocht uit, die doorgaans binnen twee tot drie weken kandidaatprofielen oplevert, en niemand begint voordat u ja hebt gezegd.
Hoe huren we technisch schrijvers in via BigTree108?
Vertel ons over het werk, het senioriteitsniveau en de uren die u nodig hebt. Wij stellen een of twee mensen voor met hun profielen, u interviewt hen zoals u uw eigen medewerker zou interviewen, en u tekent één overeenkomst met BIG TREE 108 LLC en ontvangt één factuur per maand.
Wie is eigenaar van het werk dat zij opleveren?
U. Elke specialist heeft een getekend contract met BigTree108 dat alle werkresultaten aan het bedrijf toewijst, en onze overeenkomst met u draagt ze verder aan u over. Code, ontwerpen en documenten worden geleverd in uw eigen repositories en tools, en niet bewaard op een plek waar alleen wij ze kunnen wijzigen.
Loopt uw documentatie achter op het product?
Vertel ons over het product, de lezers en waar de documentatie nu staat. Binnen één werkdag krijgt u antwoord: kandidaatprofielen of een documentatieplan.