technical-doc-creator
Create HTML technical documentation with code blocks, API workflows, system architecture diagrams, and syntax highlighting. Use when users request technical documentation, API docs, API references, code examples, or developer documentation.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Create HTML technical documentation with code blocks, API workflows, system architecture diagrams, and syntax highlighting. Use when users request technical documentation, API docs, API references, code examples, or developer documentation.
How to use
Zainstaluj skill technical-doc-creator w swoim środowisku Claude lub Copilot, dodając go do dostępnych narzędzi.
Poproś skill o utworzenie dokumentacji, używając jednej z sugerowanych fraz: "Utwórz dokumentację API dla [endpointy]", "Wygeneruj dokumenty techniczne dla [system]", "Udokumentuj referencję API" lub "Stwórz dokumentację dla deweloperów".
Skill automatycznie strukturyzuje dokument w sekcje: przegląd (cel, kluczowe cechy, stos technologiczny), instrukcje instalacji i szybki start, referencja API z przykładami, bloki kodu ze składnią, diagram architektury oraz przepływy pracy.
Każdy endpoint API zostanie sformatowany z kolorową metodą HTTP (GET, POST itp.), ścieżką, opisem, przykładowym żądaniem curl oraz strukturą odpowiedzi.
Kod będzie wyświetlany w ciemnym tle z podświetlaniem składni, a cały dokument będzie responsywny i gotowy do publikacji.
Pobierz wygenerowany HTML i otwórz w przeglądarce lub umieść na serwerze dokumentacji.