Ich verfasse technische Dokumentation zu Software, IT und Technologie

Hallo;

Technisches Schreiben scheitert immer wieder auf die gleiche Weise: Es wird von jemandem geschrieben, der das System bereits versteht, für jemanden, der es noch nicht tut. Genau an dieser Stelle arbeite ich, über Softwareentwicklung, IT-Projekte und Technologiethemen im Allgemeinen.

Das umfasst:

• API-Dokumentation mit Endpunkten, Parametern und Beispielen, die tatsächlich funktionieren, wenn man sie kopiert
• README-Dateien und Setup-Anleitungen in der richtigen Reihenfolge, Annahmen werden explizit gemacht
• IT-Projekt-Dokumentation, Implementierungsleitfäden, System-Spezifikationen, interne Prozessdokumente
• Technologieartikel und Berichte, die erklären, wie etwas funktioniert oder warum es wichtig ist, für Leser, die noch keine Experten sind
• Runbooks und Troubleshooting-Dokumente, geschrieben für diejenigen, die um 2 Uhr morgens feststecken, nicht für die Person, die es gebaut hat

Hauptfokus:

• Softwareentwicklungsberichte
• Technische Berichte
• Technische Blogs
• IT-Berichte
• Data Mining
• Big Data
• Cloud Computing
• Website-Inhalte
• IOT
• Benutzeranforderungsberichte
• Alle Arten von technischer Berichterstattung
• Andere technische Schreibarbeiten

Teile deine Dokumente, Spezifikationen oder dein Thema sowie deine Deadline, um loszulegen.