write-documentation

Write and format Rust documentation correctly. Apply proactively when writing code with rustdoc comments (//! or ///). Covers voice u0026 tone, prose style (opening lines, explicit subjects, verb tense), structure (inverted pyramid), intra-doc links (crate:: paths, reference-style), constant conventions (binary/byte literal/decimal), and formatting (cargo rustdoc-fmt). Also use retroactively via /fix-intradoc-links, /fix-comments, or /fix-md-tables commands.

1. Zainstaluj skill write-documentation w swoim środowisku Claude lub Copilot, wskazując repozytorium r3bl-org.

2. Podczas pisania nowego kodu zawierającego komentarze dokumentacyjne (/// dla elementów lub //! dla modułów), skill automatycznie zasugeruje poprawki dotyczące tonu, jasności i struktury.

3. Jeśli dodajesz linki do innych typów lub modułów w dokumentacji, skill upewni się, że ścieżki (crate::) są poprawne i stosuje konwencję linków referencyjnych.

4. Dla istniejącej dokumentacji użyj komendy /fix-intradoc-links, aby naprawić uszkodzone linki i przekonwertować linki inline na styl referencyjny.

5. Uruchom /fix-comments, aby sprawdzić konwencje stałych (literały binarne, bajty, dziesiętne) w komentarzach dokumentacyjnych.

6. Użyj /fix-md-tables do formatowania tabel markdown w dokumentacji, a następnie uruchom cargo rustdoc-fmt, aby ujednolicić całą dokumentację.