technical-writer

Skill do pisania jasnej, użytkowniczej dokumentacji technicznej. Pomaga w tworzeniu dokumentacji API, plików README, tutoriali, przewodników użytkownika i wyjaśnianiu złożonych koncepcji techicznych. Stosuje zasady user-centered writing: aktywny głos, proste zdania, praktyczne przykłady i progresywne ujawnianie informacji od prostych do zaawansowanych.

1. Aktywuj skill technical-writer, gdy potrzebujesz napisać dokumentację techniczną, plik README, dokumentację API lub tutorial dla użytkowników.

2. Określ typ dokumentu, który chcesz utworzyć: dokumentacja API, przewodnik instalacji, quick start, manual użytkownika, changelog lub przewodnik onboardingu.

3. Podaj kontekst: co dokumentujesz, dla kogo (początkujący czy zaawansowani użytkownicy) i jakie są kluczowe funkcje lub koncepty do wyjaśnienia.

4. Skill zastosuje zasady user-centered writing: zacznie od celu użytkownika, użyje aktywnego głosu, będzie trzymać zdania poniżej 25 słów i wyjaśni terminy techniczne przy pierwszym użyciu.

5. Otrzymasz strukturę dokumentu z praktycznymi przykładami, kodem do skopiowania, oczekiwanymi wynikami i informacją o częstych błędach.

6. Zawartość będzie skanowalna: z opisowymi nagłówkami, listami punktowanymi, blokami kodu i jasną hierarchią informacji od prostych koncepcji do zaawansowanych tematów.