writing-clearly-and-concisely
Pisz jasno i zwięźle — umiejętność do czyszczenia tekstu według zasad Strunk'a
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do poprawy jakości każdego tekstu przeznaczonego dla ludzi: dokumentacji, wiadomości w kodzie, komunikatów błędów i raportów. Opiera się na ponadczasowych regułach z "Elementów stylu" Williama Strunk'a — eliminuje zbędne słowa, wzmacnia głos czynny i czyni tekst bardziej profesjonalnym i czytelnym.
Jak używać
Użyj tej umiejętności zawsze, gdy piszesz tekst dla człowieka — dokumentację, komunikaty w kodzie, opisy pull requestów, teksty interfejsu użytkownika, raporty lub wyjaśnienia.
Napisz swój wstępny draft, korzystając z własnego osądu i doświadczenia.
Jeśli masz ograniczoną ilość kontekstu, wyślij draft wraz z odpowiednią sekcją pliku do podagenta, aby przeprowadził korektę i zwrócił poprawioną wersję.
Pamiętaj o kluczowych zasadach: używaj strony czynnej zamiast biernej, formułuj zdania pozytywnie, wybieraj konkretny i specyficzny język, omijaj zbędne słowa i utrzymuj powiązane słowa blisko siebie.
Sprawdź, czy każde zdanie ma jasny cel — jeden temat na akapit, zdanie tematyczne na początku, bez zbędnych przejść między luźnymi zdaniami.