AWS-Dokumentationsprüfer

Der Inspector analysiert AWS-Dokumentation über Dienste hinweg auf Genauigkeit, Vollständigkeit und Konsistenz. Eingaben wie service_name, doc_version, region und doc_source_url werden akzeptiert; anschließend wird eine Suite von Qualitätschecks gegen AWS-Referenzseiten und Release Notes angewendet. Zielnutzer sind API-Entwickler, technische Redakteure und Governance-Teams, die sicherstellen müssen, dass Dienstreferenzen bei raschen Releases konsistent bleiben.
Grundlegende Checks umfassen Terminologieabgleich, Konsistenz bei Parameterbenennungen, Datentypen und Einheiten, das Vorhandensein erforderlicher Abschnitte sowie Validierung von Querverweisen zu AWS-Referenzseiten. Versionsabhängige Differenzberichte zeigen Hinzufügungen oder Entfernungen zwischen Dokumentversionen. Die Punktbewertung ist deterministisch für Kernprüfungen; optionale ML-gestützte Bewertung bewertet Lesbarkeit und Terminologie-Abweichungen.
Ablauf: Eingaben bereitstellen, Analyseumfang auswählen (Kern- vs. Fortgeschrittene), Analyse ausführen, strukturierten Bericht überprüfen und JSON oder Markdown exportieren. Ausgaben umfassen Findings-Liste, Abhilfemaßnahmen, Compliance-Score und eine Änderungsdiff-Zusammenfassung. Das Tool priorisiert hochwirksame Probleme wie mehrdeutige Parametrierungen und fehlende Sicherheitshinweise.
Zielgruppen: Produktmanager, API-Entwickler und technische Redakteure, die reproduzierbare, auditierbare Dokumentationsqualität benötigen. Differenzierender Mehrwert: versionsabhängige Konsistenz über Dienste hinweg, exportierbare Audit-Logs und direkte Zuordnung zu kanonischen AWS-Dokumenten. Es konzentriert sich auf Domänenlogik und umsetzbare Outputs, ohne UI/UX-Design.