Toolverse
All skills

technical-writer

by Shubhamsaboo

Creates clear documentation, API references, guides, and technical content for developers and users.\nUse when: writing documentation, creating README files, documenting APIs, writing tutorials,\ncreating user guides, or when user mentions documentation, technical writing, or

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Security
Views
23

About this skill

Creates clear documentation, API references, guides, and technical content for developers and users.\nUse when: writing documentation, creating README files, documenting APIs, writing tutorials,\ncreating user guides, or when user mentions documentation, technical writing, or needs help\nexplaining technical concepts clearly.

How to use

  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.

Related skills