Ich erstelle technische Dokumentation für dein Softwareprojekt
Aufstrebender Platform Engineer
Über diesen Service
Brauchst du klare technische Dokumentation für dein Softwareprojekt?
Ich kann dir helfen, Dokumentationen zu erstellen oder zu verbessern, wie zum Beispiel:
- README-Dateien
- Einrichtungs- und Installationsanleitungen
- Bereitstellungsdokumentation
- Architekturübersichten
- Konfigurationsanleitungen
- Fehlerbehebungsleitfäden
- Entwicklerorientierte Projektdokumentation
Am besten arbeite ich mit Software-, Backend-, Linux-, Docker-, Netzwerk- und Infrastrukturprojekten.
Je nach gewähltem Paket kann ich ein einzelnes kleines Projekt dokumentieren oder eine umfassendere Dokumentationssammlung für mehrere Bereiche vorbereiten.
Um eine präzise Dokumentation zu erstellen, gib bitte genügend Projektkontext an, wie dein Repository, vorhandene Notizen, Architekturdetails, Screenshots, Befehle oder den erwarteten Workflow.
Standardmäßig biete ich keine tiefgehende Reverse Engineering oder umfangreiche Codebasis-Recherche an. Falls dein Projekt eine umfangreiche Untersuchung erfordert, bevor die Dokumentation beginnen kann, kontaktiere mich bitte zuerst für ein individuelles Angebot.
Alle Dokumentationen werden klar, konsistent und für die Zielgruppe strukturiert geschrieben.
Dokumenttyp:
Dokumentation
Branche:
Software
Sprache:
Englisch
•
Malaiisch
Bevorzugte Lieferart
Bitte informiere den Freelancer über alle Präferenzen oder Bedenken in Bezug auf den Einsatz von KI-Tools bei der Ausführung und/oder Lieferung deines Auftrags.
Mein Portfolio
FAQ
Automatische Übersetzung
Welche Arten von Dokumentation kannst du erstellen?
README-Dateien, Einrichtungsanleitungen, Deployment-Guides, Architekturübersichten, Konfigurationsanleitungen, Troubleshooting-Dokumentation und entwicklerorientierte Projektdokumentation.
Was benötigen Sie von mir, bevor Sie beginnen?
Bitte stelle das Projekt-Repository oder relevante Dateien, vorhandene Notizen, die Zielgruppe, den erwarteten Dokumentationsumfang und alle wichtigen Details zu Einrichtung oder Deployment bereit.
Kannst du mein Projekt direkt aus dem Quellcode verstehen?
Ich kann ein vernünftig großes Projekt prüfen, um seine Struktur zu verstehen, aber die Standardpakete beinhalten kein umfangreiches Reverse Engineering großer oder nicht dokumentierter Codebasen. Kontaktiere mich zuerst, falls eine umfangreiche Untersuchung notwendig ist.
Kannst du Linux-, Docker- oder Infrastrukturprojekte dokumentieren?
Ja. Ich bin vertraut mit der Dokumentation von Linux-Umgebungen, Docker- und Docker-Compose-Deployments, Backend-Services, Netzwerken, Monitoring und verwandten Infrastruktur-Workflows.
Kannst du einem bestehenden Dokumentationsstil folgen?
Ja. Standard- und Premium-Pakete können nach einem bereitgestellten Styleguide oder einer bestehenden Dokumentationsstruktur formatiert werden.

