CommunityProgramação e Desenvolvimentogithub.com

jeffallan/documentador-de-codigo

Gera, formata e valida documentação técnica — incluindo docstrings, especificações OpenAPI/Swagger, anotações JSDoc, portais de documentação e guias do usuário.

O que é documentador-de-codigo?

O skill jeffallan/code-documenter é uma ferramenta especializada para desenvolvedores e agentes de IA que precisam gerar, formatar e validar documentação técnica de forma automatizada. Ele suporta múltiplos formatos e plataformas, incluindo docstrings para funções e classes, especificações OpenAPI/Swagger para APIs REST, anotações JSDoc para código JavaScript/TypeScript, portais de documentação e guias do usuário. O skill é particularmente útil em fluxos de trabalho de desenvolvimento onde a documentação precisa ser mantida consistente com o código, como durante a criação de APIs, construção de sites de documentação ou escrita de tutoriais. Ele pode ser invocado diretamente por comandos de IA em editores como Cursor, Codex ou Claude Code, analisando o código-fonte e produzindo documentação estruturada. Sua funcionalidade principal inclui a geração automática de documentação a partir do código, validação de conformidade com padrões como OpenAPI e JSDoc, e formatação para saída em markdown ou outros formatos populares. O skill é essencial para equipes que buscam automatizar o processo de documentação, reduzir erros manuais e manter a documentação sempre atualizada com o código.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/jeffallan/claude-skills/tree/main/skills/code-documenter

Installed? Explore more Programação e Desenvolvimento skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

Ver original→Navegar por todas as habilidades

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentação

O que documentador-de-codigo faz?

Gera, formata e valida documentação técnica — incluindo docstrings, especificações OpenAPI/Swagger, anotações JSDoc, portais de documentação e guias do usuário. Use ao adicionar docstrings a funções ou classes, criar documentação de API, construir sites de documentação ou escrever tutoriais e guias do usuário. Invoque para especificações OpenAPI/Swagger, JSDoc, portais de documentação e guias de introdução.

Visão Geral

Este skill permite que você:

  • Gere docstrings automaticamente para funções e classes em diversas linguagens.
  • Formate especificações OpenAPI/Swagger a partir de código existente.
  • Valide anotações JSDoc e outros formatos de documentação.
  • Crie portais de documentação e guias do usuário estruturados.

Como Usar

Invoque o skill com um comando natural, como:

Use o skill de documentador de código para gerar docstrings para todas as funções neste arquivo.

Ou para gerar uma especificação OpenAPI:

Invoque jeffallan/code-documenter para criar uma especificação OpenAPI para esta API REST.

Plataformas Suportadas

  • Claude Code
  • Cursor
  • Codex
  • Qualquer outro agente de codificação compatível com skills

Exemplos de Uso

Gerar Docstrings

Dado um arquivo Python:

def calcular_total(preco, quantidade):
    return preco * quantidade

O skill pode gerar:

def calcular_total(preco: float, quantidade: int) -> float:
    """
    Calcula o valor total de um item.

    Args:
        preco (float): O preço unitário do item.
        quantidade (int): A quantidade de itens.

    Returns:
        float: O valor total calculado.
    """
    return preco * quantidade

Criar Especificação OpenAPI

Para um endpoint Express.js, o skill pode gerar:

openapi: 3.0.0
info:
  title: API de Exemplo
  version: 1.0.0
paths:
  /itens:
    get:
      summary: Lista todos os itens
      responses:
        '200':
          description: Lista de itens retornada com sucesso

Notas

  • O skill preserva comentários e anotações existentes sempre que possível.
  • Para validação, ele verifica a conformidade com padrões como OpenAPI 3.0 e JSDoc.
  • A saída é formatada em Markdown ou no formato especificado pelo usuário.

Licença

Consulte o repositório original para detalhes de licenciamento.

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

jeffallan/angular-architect

Generates Angular 17+ standalone components, configures advanced routing with lazy loading and guards, implements NgRx state management, applies RxJS patterns, and optimizes bundle performance. Use when building Angular 17+ applications with standalone components or signals, setting up NgRx stores, establishing RxJS reactive patterns, performance tuning, or writing Angular tests for enterprise apps.

jeffallan/api-designer

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

jeffallan/architecture-designer

Use when designing new high-level system architecture, reviewing existing designs, or making architectural decisions. Invoke to create architecture diagrams, write Architecture Decision Records (ADRs), evaluate technology trade-offs, design component interactions, and plan for scalability. Use for system design, architecture review, microservices structuring, ADR authoring, scalability planning, and infrastructure pattern selection — distinct from code-level design patterns or database-only design tasks.

jeffallan/atlassian-mcp

Integrates with Atlassian products to manage project tracking and documentation via MCP protocol. Use when querying Jira issues with JQL filters, creating and updating tickets with custom fields, searching or editing Confluence pages with CQL, managing sprints and backlogs, setting up MCP server authentication, syncing documentation, or debugging Atlassian API integrations.

jeffallan/chaos-engineer

Designs chaos experiments, creates failure injection frameworks, and facilitates game day exercises for distributed systems — producing runbooks, experiment manifests, rollback procedures, and post-mortem templates. Use when designing chaos experiments, implementing failure injection frameworks, or conducting game day exercises. Invoke for chaos experiments, resilience testing, blast radius control, game days, antifragile systems, fault injection, Chaos Monkey, Litmus Chaos.

jeffallan/cli-developer

Use when building CLI tools, implementing argument parsing, or adding interactive prompts. Invoke for parsing flags and subcommands, displaying progress bars and spinners, generating bash/zsh/fish completion scripts, CLI design, shell completions, and cross-platform terminal applications using commander, click, typer, or cobra.

jeffallan/cloud-architect

Designs cloud architectures, creates migration plans, generates cost optimization recommendations, and produces disaster recovery strategies across AWS, Azure, and GCP. Use when designing cloud architectures, planning migrations, or optimizing multi-cloud deployments. Invoke for Well-Architected Framework, cost optimization, disaster recovery, landing zones, security architecture, serverless design.

jeffallan/code-reviewer

Analyzes code diffs and files to identify bugs, security vulnerabilities (SQL injection, XSS, insecure deserialization), code smells, N+1 queries, naming issues, and architectural concerns, then produces a structured review report with prioritized, actionable feedback. Use when reviewing pull requests, conducting code quality audits, identifying refactoring opportunities, or checking for security issues. Invoke for PR reviews, code quality checks, refactoring suggestions, review code, code quality. Complements specialized skills (security-reviewer, test-master) by providing broad-scope review across correctness, performance, maintainability, and test coverage in a single pass.

jeffallan/cpp-pro

Writes, optimizes, and debugs C++ applications using modern C++20/23 features, template metaprogramming, and high-performance systems techniques. Use when building or refactoring C++ code requiring concepts, ranges, coroutines, SIMD optimization, or careful memory management — or when addressing performance bottlenecks, concurrency issues, and build system configuration with CMake.

jeffallan/csharp-developer

Use when building C# applications with .NET 8+, ASP.NET Core APIs, or Blazor web apps. Builds REST APIs using minimal or controller-based routing, configures database access with Entity Framework Core, implements async patterns and cancellation, structures applications with CQRS via MediatR, and scaffolds Blazor components with state management. Invoke for C#, .NET, ASP.NET Core, Blazor, Entity Framework, EF Core, Minimal API, MAUI, SignalR.

jeffallan/database-optimizer

Optimizes database queries and improves performance across PostgreSQL and MySQL systems. Use when investigating slow queries, analyzing execution plans, or optimizing database performance. Invoke for index design, query rewrites, configuration tuning, partitioning strategies, lock contention resolution.

jeffallan/debugging-wizard

Parses error messages, traces execution flow through stack traces, correlates log entries to identify failure points, and applies systematic hypothesis-driven methodology to isolate and resolve bugs. Use when investigating errors, analyzing stack traces, finding root causes of unexpected behavior, troubleshooting crashes, or performing log analysis, error investigation, or root cause analysis.

jeffallan/devops-engineer

Creates Dockerfiles, configures CI/CD pipelines, writes Kubernetes manifests, and generates Terraform/Pulumi infrastructure templates. Handles deployment automation, GitOps configuration, incident response runbooks, and internal developer platform tooling. Use when setting up CI/CD pipelines, containerizing applications, managing infrastructure as code, deploying to Kubernetes clusters, configuring cloud platforms, automating releases, or responding to production incidents. Invoke for pipelines, Docker, Kubernetes, GitOps, Terraform, GitHub Actions, on-call, or platform engineering.

jeffallan/django-expert

Use when building Django web applications or REST APIs with Django REST Framework. Invoke when working with settings.py, models.py, manage.py, or any Django project file. Creates Django models with proper indexes, optimizes ORM queries using select_related/prefetch_related, builds DRF serializers and viewsets, and configures JWT authentication. Trigger terms: Django, DRF, Django REST Framework, Django ORM, Django model, serializer, viewset, Python web.

jeffallan/dotnet-core-expert

Use when building .NET 8 applications with minimal APIs, clean architecture, or cloud-native microservices. Invoke for Entity Framework Core, CQRS with MediatR, JWT authentication, AOT compilation.

jeffallan/embedded-systems

Use when developing firmware for microcontrollers, implementing RTOS applications, or optimizing power consumption. Invoke for STM32, ESP32, FreeRTOS, bare-metal, power optimization, real-time systems, configure peripherals, write interrupt handlers, implement DMA transfers, debug timing issues.

jeffallan/fastapi-expert

Use when building high-performance async Python APIs with FastAPI and Pydantic V2. Invoke to create REST endpoints, define Pydantic models, implement authentication flows, set up async SQLAlchemy database operations, add JWT authentication, build WebSocket endpoints, or generate OpenAPI documentation. Trigger terms: FastAPI, Pydantic, async Python, Python API, REST API Python, SQLAlchemy async, JWT authentication, OpenAPI, Swagger Python.

jeffallan/feature-forge

Conducts structured requirements workshops to produce feature specifications, user stories, EARS-format functional requirements, acceptance criteria, and implementation checklists. Use when defining new features, gathering requirements, or writing specifications. Invoke for feature definition, requirements gathering, user stories, EARS format specs, PRDs, acceptance criteria, or requirement matrices.

jeffallan/fine-tuning-expert

Use when fine-tuning LLMs, training custom models, or adapting foundation models for specific tasks. Invoke for configuring LoRA/QLoRA adapters, preparing JSONL training datasets, setting hyperparameters for fine-tuning runs, adapter training, transfer learning, finetuning with Hugging Face PEFT, OpenAI fine-tuning, instruction tuning, RLHF, DPO, or quantizing and deploying fine-tuned models. Trigger terms include: LoRA, QLoRA, PEFT, finetuning, fine-tuning, adapter tuning, LLM training, model training, custom model.

jeffallan/flutter-expert

Use when building cross-platform applications with Flutter 3+ and Dart. Invoke for widget development, Riverpod/Bloc state management, GoRouter navigation, platform-specific implementations, performance optimization.

Habilidades Relacionadas

steipete/bluebubbles

Send and manage iMessages via BlueBubbles, including attachments, tapbacks, edits, replies, and groups.

community

steipete/eightctl

Control Eight Sleep pods (status, temperature, alarms, schedules).

community

steipete/blucli

BluOS CLI (blu) for discovery, playback, grouping, and volume.

community

steipete/bear-notes

Create, search, and manage Bear notes via grizzly CLI.

community

steipete/camsnap

Capture frames or clips from RTSP/ONVIF cameras.

community

steipete/gifgrep

Search GIF providers with CLI/TUI, download results, and extract stills/sheets.

community
← More Programação e Desenvolvimento skills