write-documentation
Pisz dokumentację Rust zgodnie ze standardami – automatycznie i poprawnie
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do pisania i formatowania dokumentacji Rust. Pomaga podczas tworzenia komentarzy rustdoc (/// i //!) oraz naprawia istniejące dokumenty. Obejmuje wytyczne dotyczące tonu, stylu tekstu, struktury, linków wewnętrznych, konwencji stałych i formatowania. Używaj proaktywnie przy pisaniu kodu lub retroaktywnie za pomocą komend /fix-intradoc-links, /fix-comments i /fix-md-tables.
Jak używać
Zainstaluj skill write-documentation w swoim środowisku Claude lub Copilot, wskazując repozytorium r3bl-org.
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.
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.
Dla istniejącej dokumentacji użyj komendy /fix-intradoc-links, aby naprawić uszkodzone linki i przekonwertować linki inline na styl referencyjny.
Uruchom /fix-comments, aby sprawdzić konwencje stałych (literały binarne, bajty, dziesiętne) w komentarzach dokumentacyjnych.
Użyj /fix-md-tables do formatowania tabel markdown w dokumentacji, a następnie uruchom cargo rustdoc-fmt, aby ujednolicić całą dokumentację.