Artikel mit Tag: Qualität
Generativer Text kann vollständig klingen und dabei Defaults, Garantien oder Quellen erfinden. Baue Verifikation um autoritative Quellen, ausführbare Beispiele und sichtbare Unsicherheit. Der gefährliche AI-Fehler in Dokumentation ist selten schlechte Grammatik.
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 „Suche für Dokumentation wählen: bei Fehlerszenarien beginnen“, der langfristig wartbare Dokumentation unterstützt. „Suche für Dokumentation wählen: bei Fehlerszenarien beginnen“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Ein praktischer und prüfbarer Ansatz für „Dokumentationsschulden: Was Nutzern wirklich schadet“, der langfristig wartbare Dokumentation unterstützt. „Dokumentationsschulden: Was Nutzern wirklich schadet“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Dokumentation als Build-Artefakt behandeln: Struktur, Links, Beispiele und Publikationsregeln vor der Veröffentlichung prüfen. CI kann nicht beurteilen, ob eine Erklärung nützlich ist, aber vorhersehbare Defekte vor dem menschlichen Review abfangen.
Ein praktischer und prüfbarer Ansatz für „Dokumentationsmetriken, die mehr aussagen als Seitenaufrufe“, der langfristig wartbare Dokumentation unterstützt. „Dokumentationsmetriken, die mehr aussagen als Seitenaufrufe“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Ein guter Review-Prozess macht Verantwortung sichtbar, verkürzt Wartezeiten und trennt fachliche, redaktionelle und produktseitige Prüfung. Autor, fachlichen Reviewer, Redaktion und finalen Owner definieren.
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 Glossar wird nützlich, wenn es Entscheidungen in Produkt, Interface und Dokumentation steuert statt nur Wörter zu sammeln. Ein guter Eintrag enthält bevorzugten Begriff, Definition, verbotene oder veraltete Varianten, Kontext und Owner.
Ein praktischer und prüfbarer Ansatz für „Technische Redakteure ohne Tricktests einstellen“, der langfristig wartbare Dokumentation unterstützt. „Technische Redakteure ohne Tricktests einstellen“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Eine Struktur, die bei fünfzig Seiten funktioniert, kann bei fünfhundert scheitern. Navigation sollte sich an Nutzeraufgaben, Inhaltstypen und stabilen Konzepten orientieren — nicht am Organigramm. Kleine Dokumentationsbestände überleben fast jede Navigation.