Ich schreibe klare technische Dokumentation oder eine Anleitung für dein Projekt
Persönlicher Entwickler IT-Support
Über diesen Service
Die meisten technischen Projekte haben Dokumentationen, die entweder fehlen, verwirrend sind oder von jemandem geschrieben wurden, der das Produkt zu gut kennt, um es anderen klar zu erklären.
Ich schreibe technische Anleitungen, Tutorials und Dokumentationen für Entwickler, Open-Source-Projekte und kleine Softwareteams. Ich verstehe Linux, Docker, Netzwerke und Systemadministration – deshalb kann ich deinen Code oder deine Konfiguration lesen, verstehen, was sie tatsächlich tun, und es so erklären, dass es jemand anderes wirklich nachvollziehen kann.
Was das in der Praxis bedeutet: klare Schritte, richtige Befehle und echte Erklärungen, was jeder Schritt macht und warum – nicht nur „Führe das aus und hoffe das Beste“.
Basic: Ein einzelner fokussierter Leitfaden oder README-Abschnitt. Installationsschritte, ein spezieller Prozess oder eine kurze Anleitung bis zu 600 Wörter.
Standard: Ein vollständiges Tutorial, das einen kompletten Workflow von Anfang bis Ende abdeckt, bis zu 1.500 Wörter.
Premium: Mehrteilige Dokumentation, die dein ganzes Tool oder Projekt abdeckt, bis zu 3.000 Wörter mit durchgängig einheitlicher Struktur und Formatierung.
Schick mir vor der Bestellung eine Nachricht. Sag mir, was dokumentiert werden soll, wer die Zielgruppe ist und in welchem Format du es brauchst. Ich bestätige den Umfang und den Zeitplan, bevor du dich festlegst.
Dokumenttyp:
Dokumentation
•
Andere
Branche:
Technologie
Sprache:
Englisch
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 Informationen benötigen Sie von mir, um loslegen zu können?
Eine Beschreibung dessen, was dokumentiert werden muss, wer es lesen wird und jegliches vorhandenes Material – Code, Konfigurationen, grobe Notizen oder eine frühere Version der Dokumentation. Je mehr Kontext du mir im Voraus gibst, desto weniger Rückfragen entstehen.
Musst du das technische Thema verstehen, bevor du darüber schreiben kannst?
Ich habe praktische Erfahrung mit Linux, Docker, Netzwerken und Systemadministration, daher kann ich bei Projekten in diesem Bereich sofort loslegen. Für Themen außerhalb dieses Bereichs brauche ich eine Einführung von dir – was oft sinnvoll ist, weil es hilft, herauszufinden, was wirklich wichtig ist.
In welchem Format wird die Dokumentation geliefert?
Standardmäßig Markdown, was für GitHub-READMEs, Dokumentationsseiten und die meisten Entwickler-Tools funktioniert. Wenn du ein anderes Format brauchst – Plain Text, Google Doc, Word – erwähne das einfach, wenn du mir schreibst.
Kannst du Dokumentationen aktualisieren oder verbessern, die ich bereits geschrieben habe?
Ja. Schick mir, was du hast, und sag mir, was nicht funktioniert. Das Umschreiben bestehender Dokumente fällt in der Regel unter die Standard- oder Premium-Option, je nach Umfang.
Was ist, wenn mein Projekt außerhalb von Linux und Netzwerken liegt?
Schick mir vor der Bestellung eine Nachricht und beschreibe das Thema. Wenn ich es genau dokumentieren kann, sage ich dir das. Wenn es außerhalb meines Fachgebiets liegt, werde ich dir das auch sagen, anstatt dein Geld zu nehmen und etwas Minderwertiges zu liefern.

