Artikel mit Tag: Schreiben
Barrierefreiheit in der Dokumentation endet nicht bei Navigation und Kontrast. Auch Codebeispiele, JSON-Antworten und Referenztabellen müssen ohne reine Farbcodierung verständlich und nutzbar bleiben.
Ein technisch gültiger Request ist noch kein gutes Beispiel. Verwende realistische Werte und Sequenzen, die das mentale Modell der API zeigen und den nächsten Schritt vorhersehbar machen. Ein aus dem Schema erzeugtes Beispiel kann syntaktisch korrekt und didaktisch wertlos sein.
Ein praktischer und prüfbarer Ansatz für „Authentifizierungsdokumentation, die Support-Tickets verhindert“, der langfristig wartbare Dokumentation unterstützt. „Authentifizierungsdokumentation, die Support-Tickets verhindert“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Eine nützliche Leseliste ist heute keine Sammlung von Klassikern. Vergleichen Sie aktuelle Leitfäden von Microsoft, Google, GitHub und IBM, prüfen Sie Strukturen mit Diátaxis und machen Sie aus jeder Lektüre eine konkrete Dokumentationsübung.
Über Dokumentation zu lesen hilft, aber Fähigkeiten wachsen schneller durch wiederholte kleine Übungen zu Recherche, Struktur, Editing und Verification mit klarem Feedback. „Besser im Technical Writing werden“ ist zu breit.
Ein praktischer und prüfbarer Ansatz für „Diagramme als Code: wann sie helfen und wann nicht“, der langfristig wartbare Dokumentation unterstützt. „Diagramme als Code: wann sie helfen und wann nicht“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Ein praktischer und prüfbarer Ansatz für „API-Fehler so dokumentieren, dass Entwickler reagieren können“, der langfristig wartbare Dokumentation unterstützt. „API-Fehler so dokumentieren, dass Entwickler reagieren können“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Gute API-Dokumentation verbindet maschinenlesbare Verträge mit Erklärungen, ausführbaren Beispielen und klar beschriebenem Fehlerverhalten. REST-API-Dokumentation hat zwei Zielgruppen: Maschinen und Menschen.
Ein praktischer und prüfbarer Ansatz für „Redaktionsübungen, die technisches Schreiben schneller verbessern“, der langfristig wartbare Dokumentation unterstützt. „Redaktionsübungen, die technisches Schreiben schneller verbessern“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Ein praktischer und prüfbarer Ansatz für „Markdown im großen Maßstab: Regeln gegen Repository-Chaos“, der langfristig wartbare Dokumentation unterstützt. „Markdown im großen Maßstab: Regeln gegen Repository-Chaos“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Eine OpenAPI-Beschreibung kann eine präzise Reference erzeugen. Developers brauchen zusätzlich Konzepte, Task Flows, Authentifizierung, Beispiele und Recovery, die ein Schema allein nicht erklärt. OpenAPI beschreibt Operations, Parameter, Request- und Response-Strukturen, Status Codes und wiederverwendbare Schemas sehr gut.
Ein praktischer und prüfbarer Ansatz für „Release Notes, aus denen Nutzer konkrete Schritte ableiten können“, der langfristig wartbare Dokumentation unterstützt. „Release Notes, aus denen Nutzer konkrete Schritte ableiten können“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.