Technische Dokumentation
So aufschreiben, dass die nächste Person weiterkommt
Übergaben, Betriebsanleitungen und Handbücher ermöglichen Ihren Mitarbeitenden, das System zu betreiben, ohne die ursprünglichen Entwickler anrufen zu müssen.
Ausgewählte Arbeiten, die diese Leistung zeigen.

Foto: jessica45 / Pixabay 
Foto: stevepb / Pixabay
Die Leistung in ein Ergebnis überführen
Machen Sie „Technische Dokumentation“ für ein Geschäftsergebnis nutzbar. Wir können die technische Arbeit mit den Nutzern, Betriebsabläufen und Entscheidungen verbinden, die sie unterstützen soll. Übergaben, Betriebsanleitungen und Handbücher ermöglichen Ihren Mitarbeitenden, das System zu betreiben, ohne die ursprünglichen Entwickler anrufen zu müssen.
Die passenden Arbeiten prüfen
Prüfen Sie unser Vorgehen anhand der zugehörigen Arbeiten auf dieser Seite. Fragen Sie nach den Abwägungen und den Bedingungen hinter jedem Ergebnis. Ein Infrastrukturplan für 14 Abteilungen — 14 Forschungsabteilungen mit einem gemeinsamen Infrastrukturplan
-
Ein Infrastrukturplan für 14 Abteilungen
Ein umfassendes Infrastrukturrahmenwerk für ein Forschungsinstitut mit 14 Abteilungen entworfen, mit flexiblen Modulen, einheitlichen Datenpipelines und strukturierten Supportstrategien für eine langfristige Nutzung.
-
8 Power‑BI‑Projekte mit Handbüchern umgesetzt
8 Power‑BI‑Projekte mit umfassenden Handbüchern umgesetzt und Microsoft Power BI mit einer NodeJS‑API und Python FastAPI für wirksame Datenanalyse und Visualisierung integriert.
-
50.000 Wörter Softwaredokumentation verfasst
50.000 Wörter umfassender Softwaredokumentation in Markdown auf GitHub, Craft und Confluence verfasst und damit Wissenserhalt und transparente Abläufe sichergestellt.
-
API auf Huma v2 migriert, 100 % Übereinstimmung
Die HTTP‑API von Fiber auf Huma v2 migriert — 649 Pfade und 760 Operationen — und eine vollständige Übereinstimmung (100 %) zwischen den registrierten Serverrouten und der veröffentlichten OpenAPI‑Beschreibung erreicht und beibehalten.
-
578 go‑task‑Automatisierungsziele verfasst
578 go‑task‑Automatisierungsziele für native, Docker- und HTTPS‑Entwicklungsmodi, Linting, Tests, Datenbank und Bereitstellung verfasst.
-
Repository‑Prüfengine mit 268 Checks entwickelt
Die Prüfengine des Repositorys entwickelt — 268 registrierte Commit‑Prüfungen, 277 Lint‑Regeln und 15 eigene ESLint‑Regeln — sowie 146 Tests der Prüfungen selbst, damit der Build den Standard durchsetzt und nicht erst das Review.
-
Kontinuierliche Sicherheitsprüfungen etabliert
Ein kontinuierliches Sicherheitsprogramm aufgebaut — Codeanalyse, DAST, Abhängigkeits- und Schwachstellenprüfungen, SBOM‑Erzeugung, Geheimnissuche und per SHA festgelegte Actions — ergänzt durch 21 schriftliche Sicherheitsaudits.
-
7 lesende Host‑Berichtsrollen entwickelt
Sieben schreibgeschützte Berichtsrollen entwickelt, die den Zustand eines laufenden Hosts in Markdown abbilden — Fakten, Zugriff, Git, Metriken, Verkehr, Sicherheit und Anbieterinventar — nach der Regel, dass keine Zahl erscheint, die der Lauf nicht gemessen hat.
-
Zuständigkeit nach Geheimnisleck klar geregelt
Eine Regel zum Zuständigkeitsumfang im Repository festgeschrieben, nachdem eine Umstrukturierung Inventar, Firewallfreigaben und Texte eines anderen Unternehmens hineingetragen hatte; die isolierten Rückstände weiterhin auf Geheimnisse prüfen lassen, statt sie auszuschließen.
-
Commit‑Prüfung mit 22 Lintern aufgebaut
Eine verbindliche Commit‑Prüfung aus 22 einzeiligen Lintern und fünf ausführlicheren Prüfungen aufgebaut, ohne Warnungsstufe und ohne Inline‑Unterdrückungen, für HTML, CSS, JavaScript, Python, YAML, Markdown, Shell, Links, Rechtschreibung, Geheimnisse und Typografie.
-
Entwicklung in 51 schriftlichen Vorhaben geführt
Die Website‑Entwicklung als 51 schriftliche Vorhaben in 54 Plandokumenten geführt, jeweils mit offenen Aufgaben, Messungen und verworfenen Entscheidungen — darunter sechs von acht mit dokumentierter Begründung abgelehnte Befunde zur Eignung für KI‑Agenten.
-
Dokumentation einem eigenen Linter unterstellt
Die Dokumentation einem eigenen Linter unterstellt — mit nur absenkbarem Zeilenbudget je Datei, Inhaltsverzeichnispflicht und Prüfung echter Pfade — der sechs von neun als erledigt markierte Pläne mit offenen Aufgaben und vierzehn in keinem Dokument genannte verpflichtende Commit‑Prüfungen fand.
-
106 von 106 PDF/UA‑1‑Profilprüfungen bestanden
Die PDF/UA‑1‑Validierung für neun Dokumente dokumentiert: 106 von 106 Prüfungen des konfigurierten Barrierefreiheitsprofils bestanden, während die Archivvariante eine von 146 Regeln verfehlte.
-
Abweichende Hooks und Qualitätsprüfung gefunden
Durch den Vergleich beider Listen in einem Test festgestellt, dass Commit‑Hooks und Qualitätsprüfung unterschiedliche Prüfungen ausführten, obwohl ein Dokument Gleichheit versprach — die fünf ausschließlich von Hand ausgeführten Prüfungen waren gerade diejenigen für die Lebenslauftexte.
-
Sprachübergreifende Zahlenprüfung aufgebaut
Eine sprachübergreifende Inhaltsprüfung entwickelt, die bei fehlenden Zahlen gegenüber dem Englischen und bei sprachfremder Notation fehlschlägt — dabei zwei dänische Beschreibungen ohne eine Kennzahl und sechzehn ukrainische Textstellen mit englischen Anführungszeichen gefunden.
-
Parser zur Prüfung aller FFI‑Aufrufe geschrieben
Einen Parser geschrieben, der den echten C‑Header mit 7.308 Zeilen liest und jede Aufrufstelle, jede Enum‑Konstante sowie final für jede pointerbesitzende Klasse prüft, nachdem ein handgeschriebener Platzhalterheader Aufrufe dreier entfernter Funktionen kompilieren und linken ließ, die zur Laufzeit abstürzten.
-
Fehlermeldungen ohne Schuldzuweisung verfasst
Die Fehlermeldungen der Anwendung anhand eines schriftlichen Tonalitätsstandards neu verfasst, nachdem eine abgewiesene Anmeldung dem Nutzer einen Tippfehler vorwarf, obwohl der Anbieter ein anwendungsspezifisches Passwort verlangte; den Fall mit einem anbieterspezifischen Test abgesichert.
-
4 Repositorys auf einen Historienstandard geeint
Vier Repositorys auf einen einheitlichen Historienstandard verpflichtet — Conventional Commits, ohne Emojis und Attribution‑Trailer, durch einen Commit‑Message‑Hook erzwungen — ergänzt durch 48 Anweisungsdokumente zur Arbeitsweise.
-
Sechs Sammler weisen übersprungene Eingaben aus
Sechs Berichtssammler um Angaben zu ungelesenen Eingaben ergänzt — ungeöffnete Dateien, nicht installierte Sonden, unbekannte Journalzeilen — und Schwellenwerte anhand von 116 gemessenen Stichproben bestimmt, nachdem eine blinde Erfassung und ein gesunder Host dieselbe Seite ergeben hatten.

