technical-doc-creator

Skill do tworzenia kompletnej dokumentacji technicznej w formacie HTML. Obejmuje przegląd systemu, instrukcje instalacji, referencję API z przykładami żądań i odpowiedzi, bloki kodu ze składnią, oraz diagramy architektury w SVG. Idealny dla deweloperów, którzy potrzebują szybko wygenerować dokumentację dla API, systemu lub biblioteki.

1. Zainstaluj skill technical-doc-creator w swoim środowisku Claude lub Copilot, dodając go do dostępnych narzędzi.

2. 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".

3. 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.

4. Każdy endpoint API zostanie sformatowany z kolorową metodą HTTP (GET, POST itp.), ścieżką, opisem, przykładowym żądaniem curl oraz strukturą odpowiedzi.

5. Kod będzie wyświetlany w ciemnym tle z podświetlaniem składni, a cały dokument będzie responsywny i gotowy do publikacji.

6. Pobierz wygenerowany HTML i otwórz w przeglądarce lub umieść na serwerze dokumentacji.