Technische Dokumentation
Technische Dokumentation für Softwareunternehmen: API-Referenzen, Entwicklerleitfäden, Benutzerdokumentation, Runbooks und Release Notes, als Code neben dem Produkt geschrieben und mit jedem Release aktuell gehalten.
Was unsere Technical Writer tun
API-Dokumentation
Referenz, die aus Ihrem OpenAPI- oder GraphQL-Schema generiert wird, mit Einstiegsleitfäden, Authentifizierungs-Walkthroughs und lauffähigen Beispielen drumherum, sodass die Referenz nie von Hand bearbeitet wird.
Docs as Code
Dokumentation in Markdown in Ihrem Repository, in Pull Requests wie Code geprüft und mit Docusaurus, Starlight oder einem ähnlichen Generator über dieselbe Pipeline wie das Produkt veröffentlicht.
Benutzerleitfäden und Help Center
Aufgabenbasierte Leitfäden und Help-Center-Artikel, danach geordnet, was der Leser erreichen will, gegliedert in Tutorials, Anleitungen, Referenz und Erklärung nach dem Diátaxis-Framework.
Runbooks und Betriebsleitfäden
Schritt-für-Schritt-Verfahren für Deployments, Wiederherstellungen, Incident Response und Rufbereitschaft, getestet von jemandem, der sie nicht geschrieben hat.
Release Notes und Changelogs
Release Notes, die Nutzern sagen, was sich für sie geändert hat, und Changelogs für Integratoren, aus gemergten Pull Requests entworfen und gegen das Release geprüft.
Stil- und Qualitätsprüfungen
Ein Styleguide und eine Terminologieliste, die Vale in der Pipeline durchsetzt, dazu Prüfungen auf defekte Links bei jedem Build, damit Konsistenz nicht vom Auge eines einzelnen Reviewers abhängt.
Technical Writer einstellen
In Vollzeit in Ihrem Team
Technical Writer, die zu Ihren Zeiten in Ihren Tools und Meetings arbeiten und an Ihren Lead berichten, mit ukrainischem Vertrag, Gehaltsabrechnung und Urlaub auf unserer Seite.
In Teilzeit oder als Fractional-Rolle
Technical Writer für eine festgelegte Zahl von Tagen pro Woche, wenn die Arbeit real ist, aber noch keine Vollzeitstelle rechtfertigt.
Für ein Projekt oder einen Launch
Technical Writer für einen klar umrissenen Zeitraum, von der ersten Woche bis zur Übergabe, mit einem vorab vereinbarten Enddatum.
Die Seite zum dedizierten Team erklärt, wie Spezialisten zu Ihrem Team stoßen, und die Seite zum Outsourcing behandelt Projektlieferung, Übernahmen und unsere Abrechnung.
Mit wem unsere Technical Writer zusammenarbeiten
Ingenieure und Technical Leads
Interviews, Reviews und fachliche Richtigkeit
Product Manager
Funktionen, Zielgruppen und Release-Umfang
Support-Engineers
Die Fragen, die Anwender tatsächlich stellen
UI- und UX-Designer
Oberflächentexte und Diagramme
Wie unsere Technical Writer arbeiten
Die Dokumentation lebt dort, wo der Code lebt: im Repository, im selben Pull Request geprüft wie die Änderung, die sie beschreibt, und von der Pipeline gebaut und veröffentlicht. Ein Feature ist fertig, wenn seine Dokumentation gemergt ist. So bleibt die Dokumentation so aktuell wie der Code.
Das Schreiben beginnt beim Leser: wer er ist, was er erreichen will und was er bereits weiß. Support-Tickets und Suchbegriffe zeigen, wo die bestehende Dokumentation versagt, und diese Seiten werden zuerst überarbeitet.
Weitere Rollen, die wir besetzen
Projektmanager
Projektmanagement für Softwarelieferung: IT-Projekt- und Delivery-Manager, die Pläne, Umfang, Risiken, Budgets und wöchentliches Reporting verantworten, in Vollzeit in Ihrem Team, in Teilzeit oder für ein einzelnes Projekt.
Business Analysts
Business-Analyse für Softwareprojekte: Discovery, Anforderungen, User Stories, BPMN-Prozesslandkarten und Akzeptanzkriterien, von Business Analysts in Vollzeit in Ihrem Team, in Teilzeit oder für ein Projekt.
Product Manager
Produktmanagement für Softwareprodukte: Product Manager und Product Owner für Discovery, Roadmaps, Backlogs und Produktkennzahlen, in Vollzeit in Ihrem Team, an einigen Tagen pro Woche oder für einen Launch.
Scrum Master
Scrum Master und Agile Coaching für Softwareteams: Scrum und Kanban, Flow-Metriken, beseitigte Hindernisse und Retrospektiven, die etwas verändern, in Vollzeit in Ihrem Team, in Teilzeit oder für einen festgelegten Zeitraum.
Technischer Support
Services für technischen Support bei Softwareprodukten: Support-Engineers im First- und Second-Level-Support in Ihrem Helpdesk, unter Ihrer Marke und zu den Zeiten Ihrer Kunden, in Vollzeit, in Teilzeit oder für einen Launch.
IT-Recruiting
IT-Recruiting für Unternehmen, die eigene Teams aufbauen: Rollenprofile, Sourcing, Screening und technische Interviews durch aktive Entwickler, von IT-Recruitern in Ihrem Team oder für eine Einstellungsoffensive.
Customer Success
Customer-Success-Management für SaaS- und Abonnementprodukte: Customer Success Manager für Onboarding, Adoption, Health Scores, QBRs und Verlängerungen, in Vollzeit in Ihrem Team, in Teilzeit oder für einen Launch.
Fragen zur Einstellung von Technical Writer
Kann ein Technical Writer ein System dokumentieren, das noch niemand dokumentiert hat?
Ja. Der Writer liest den Code und die Konfiguration, interviewt die Entwickler und erstellt eine Architekturübersicht, Runbooks und ein Glossar, die von den Personen geprüft werden, die das System betreiben. Es ist derselbe rein lesende erste Schritt, mit dem auch unsere Übernahmen geerbter Systeme beginnen.
Wie halten Sie die API-Dokumentation mit der API synchron?
Die Referenz wird im Build aus dem OpenAPI- oder GraphQL-Schema generiert und kann deshalb nicht von der API abweichen. Der Writer ergänzt, was ein Generator nicht leisten kann: die Einstiegsanleitung, die Beschreibung der Authentifizierung und die Beispiele, die ein Entwickler braucht, bevor die Referenz nützlich wird.
Wie schnell können Technical Writer starten?
Steht für die Position Technical Writer eine passende Person zur Verfügung, hängt der Start nur von Ihrem Interview sowie von NDA und IP-Übertragung ab. Andernfalls starten wir eine Suche, die typischerweise innerhalb von zwei bis drei Wochen Kandidatenprofile liefert, und niemand beginnt, bevor Sie zugestimmt haben.
Wie stellen wir Technical Writer über BigTree108 ein?
Nennen Sie uns die Aufgabe, die Seniorität und die benötigten Stunden. Wir schlagen ein oder zwei Personen mit ihren Profilen vor, Sie führen die Interviews so, wie Sie Ihre eigene Neueinstellung interviewen würden, unterzeichnen einen Vertrag mit BIG TREE 108 LLC und erhalten eine Rechnung im Monat.
Wem gehören die Arbeitsergebnisse?
Sie. Jeder Spezialist hat einen unterzeichneten Vertrag mit BigTree108, der alle Arbeitsergebnisse dem Unternehmen überträgt, und unser Vertrag mit Ihnen überträgt sie an Sie weiter. Code, Designs und Dokumente werden in Ihre eigenen Repositories und Tools geliefert und nicht dort aufbewahrt, wo nur wir sie ändern können.
Hinkt Ihre Dokumentation dem Produkt hinterher?
Nennen Sie uns das Produkt, seine Leser und den heutigen Ort der Dokumentation. Sie erhalten innerhalb eines Werktags eine Antwort: Kandidatenprofile oder einen Dokumentationsplan.