Bei Rust mitwirken — Dokumentation

Dokumentation ist nie perfekt, und es gibt nie genug davon. Viele Aspekte der Sprache erfordern kein tiefes Verständnis um ihre Dokumentation zu verfassen, zu verbessern oder gegenzulesen. Im Gegenteil bietet das Dokumentieren eine großartige Gelegenheit, Rust zu lernen, und es ist leicht, Verbesserungsmöglichkeiten an den Dokumenten zu finden. Eine Passage ist zu umständlich formuliert? Wichtige Informationen werden nicht erwähnt? Dein Pull Request wird gerne angenommen!

Die wirkungsvollste Dokumentation, die du schreiben kannst, ist die für Crates des Rust-Ökosystems. Während das Kernprojekt relativ gut dokumentiert ist, gilt das selbe nicht für viele der gängigen Crates und Werkzeuge, mit denen wir täglich zu tun haben. Das Verfassen von API-Dokumentation wird dir viel Dankbarkeit entgegenbringen.

Das Buch The Rust Programming Language ist das wichtigste Dokument zu Rust und wird im Hauptrepository verwaltet. Es hat sein eigenes Issue-Label, A-book, und wird kontinuierlich verbessert. Andere wichtige Dokumentation findet sich in der Rust-Referenz, der Dokumentation zur Standardbibliothek, dem Rustonomicon (einem Leitfaden zu korrektem unsafe-Code). Die Rust-Stilrichtlinien sind noch so unvollständig, dass sie bisher nicht prominent angekündigt werden; hier kann ein engagierter Helfer viel erreichen. Der Fehlerindex gibt ausführlichere Erklärungen zu Compilerfehlern. Nachdem immer neue Fehlercodes hinzukommen, muss dieser Index auf dem neuesten Stand gehalten werden. Die meiste Dokumentation im Rust-Repository liegt im Verzeichnis src/doc und wird mit dem Issue-Label A-docs gekennzeichnet. Zu guter Letzt wird dieses Dokument zusammen mit anderen Bestandteilen der Website im Rust-Website-Repository verwaltet. Um mitzuwirken bearbeite einfach den Inhalt und stelle ein Pull Request!

Ein großer Teil der Rust-Dokumentation liegt nicht im Haupt-Repository oder wird nicht vom Rust-Projekt selbst verwaltet, ist aber trotzdem unersetzlich für den Erfolg von Rust. Beispiele für solch exzellente Werke sind Rust By Example, Rust Design Patterns und rust-rosetta. Andere derartige Projekte, bei denen du mitwirken kannst, findest du bei rust-learning.

Andere Dokumentationsbegeisterte findest du immer in #rust-docs.