Toolverse
All skills

code-documentation

by skillcreatorai

Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.

Installation

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

Installation

Quick info

Category
Backend
Views
1

About this skill

Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.

How to use

  1. Zainstaluj umiejętność w swoim agencie AI, dodając ją do konfiguracji skills. Upewnij się, że masz dostęp do repozytorium projektu lub kodu, który chcesz dokumentować.

  2. Przygotuj informacje o projekcie: nazwę, krótki opis funkcjonalności, instrukcje instalacji (np. npm install) i przykłady użycia kodu, które chcesz uwzględnić w dokumentacji.

  3. Użyj umiejętności do wygenerowania strukturalnego pliku README. Skill automatycznie utworzy sekcje takie jak Quick Start, Installation, Usage i API Reference na podstawie szablonu.

  4. Dla dokumentacji API wygeneruj komentarze JSDoc/TSDoc do swoich funkcji. Podaj parametry, typy zwracane, możliwe błędy i przykłady użycia – skill sformatuje je zgodnie ze standardem.

  5. Jeśli dokumentujesz API REST, użyj generatora do utworzenia specyfikacji OpenAPI/Swagger. Skill pomoże zorganizować endpointy, parametry i odpowiedzi w czytelnym formacie.

  6. Przejrzyj wygenerowaną dokumentację, dostosuj opisy do swoich potrzeb i umieść pliki w repozytorium projektu.

Related skills

fastapi-pro

by sickn33

Build high-performance async APIs with FastAPI, SQLAlchemy 2.0, and Pydantic V2. Master microservices, WebSockets, and modern Python async patterns. Use PROACTIVELY for FastAPI development, async optimization, or API architecture.

Backend
54128

supabase-operations

by elevanaltd

Supabase operational knowledge for migrations, RLS optimization, MCP tool benchmarks, and ADR-003 compliance. Use when validating database migrations, optimizing Row-Level Security policies, checking MCP tool performance, or ensuring Supabase operational standards. Triggers on:

Backend
27109

himalaya

by openclaw

CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).

Backend
35108

drizzle

by lobehub

Drizzle ORM schema and database guide. Use when working with database schemas (src/database/schemas/*), defining tables, creating migrations, or database model code. Triggers on Drizzle schema definition, database migrations, or ORM usage questions.

Backend
79340

using-superpowers

by obra

Use when starting any conversation - establishes mandatory workflows for finding and using skills, including using Skill tool before announcing usage, following brainstorming before coding, and creating TodoWrite todos for checklists

Backend
65167

supabase-developer

by daffy0208

Build full-stack applications with Supabase (PostgreSQL, Auth, Storage, Real-time, Edge Functions). Use when implementing authentication, database design with RLS, file storage, real-time features, or serverless functions.

Backend
78170