api-reference-creator
Api Reference Creator - Auto-activating skill for Technical Documentation.\nTriggers on: api reference creator, api reference creator\nPart of the Technical Documentation skill category.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Api Reference Creator - Auto-activating skill for Technical Documentation.\nTriggers on: api reference creator, api reference creator\nPart of the Technical Documentation skill category.
How to use
Wyzwól skill, wpisując w swoim żądaniu frazę "api reference creator" lub pytając o pomoc z tworzeniem dokumentacji API — skill aktywuje się automatycznie.
Opisz API, które chcesz udokumentować: podaj listę endpointów, parametry, typy odpowiedzi oraz przykłady użycia. Im więcej szczegółów, tym dokładniejsza będzie wygenerowana dokumentacja.
Skill przeanalizuje Twoje dane i wygeneruje strukturę dokumentacji referencyjnej, uwzględniając najlepsze praktyki branżowe — takie jak jasne nazewnictwo, spójne formatowanie i kompletne opisy parametrów.
Przejrzyj wygenerowaną dokumentację i wskaż ewentualne poprawki — skill umożliwia edycję i dostosowanie treści do Twoich potrzeb.
Skill waliduje finalny dokument pod kątem zgodności ze standardami technicznymi, a następnie zapisuje go w wybranym formacie (Markdown, HTML lub inny).
Wykorzystaj gotową dokumentację API w swoim projekcie — dokumentacja jest gotowa do publikacji i integracji z systemami dokumentacji (np. Swagger, ReadTheDocs).