Inhalte für Entwicklerinnen und Entwickler

Version: 2.0 · Stand: 2026-07-04 · Struktureller Bezug: Microsoft Writing Style Guide – Developer content (CC BY 4.0)

Entwicklerdokumentation ist technischer als allgemeine Inhalte, folgt aber derselben Stimme: klar, präzise, souverän, partnerschaftlich (siehe Stimme von The White Knight Labs). Grundlagenwissen der Programmierung darf vorausgesetzt werden – der Fokus liegt auf dem, was zur Nutzung der jeweiligen Bibliothek, API oder Norm nötig ist.

Zwei Inhaltstypen tragen die Entwicklerdokumentation:

• Referenzdokumentation – das Nachschlagewerk der Programmierelemente (Klassen, Methoden, Eigenschaften).
• Codebeispiele – zeigen deren Verwendung.

Dazu kommen Konventionen zur Formatierung von Codeelementen.

Hinweis (Fachdomäne) Bei sicherheitsnahen APIs von The White Knight Labs (Kryptographie, Schlüsselverwaltung) ist besondere Präzision gefragt: Ein missverständlich dokumentierter Parameter kann zu einer unsicheren Implementierung führen. Beispiele und Beschreibungen entsprechend sorgfältig prüfen.

Redaktionsleitfaden von The White Knight Labs. Aufbau nach dem Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0); Inhalte für den deutschsprachigen Raum eigenständig erarbeitet. Sprachregeln nach amtlicher deutscher Rechtschreibung, Duden und DIN 5008.