Communitygithub.com

cdcoonce/Portfolio_Website

Gere arquivos README.md abrangentes e de alta qualidade para repositórios de código. Use essa habilidade sempre que o usuário pedir para criar, escrever, gerar, atualizar ou melhorar um README de qualquer projeto ou repositório.

O que é Portfolio_Website?

Esta habilidade foi projetada para simplificar a criação de READMEs profissionais e completos para repositórios de código, especialmente em ambientes internos de empresa. Ela analisa automaticamente o código-fonte, identifica metadados do projeto, arquitetura, dependências e fluxos de trabalho, e então gera um README.md estruturado e rico em informações. A habilidade suporta qualquer plataforma de agente de IA que execute scripts de análise de código, como Claude Code, Cursor ou Codex. Seu fluxo de trabalho consiste em três etapas: (1) análise estruturada do código em quatro fases (metadados, arquitetura, módulos, infraestrutura), (2) formulação de perguntas direcionadas para preencher lacunas que não puderam ser inferidas, e (3) geração do README final. O resultado inclui badges shields.io, diagramas Mermaid (arquitetura, fluxo de dados), tabela de variáveis de ambiente, seção de solução de problemas e muito mais. Para desenvolvedores, essa habilidade economiza horas de trabalho manual e garante que a documentação do projeto seja consistente, completa e fácil de entender para novos membros da equipe. Ela é especialmente útil em contextos onde a documentação é negligenciada ou quando é preciso integrar novos desenvolvedores rapidamente.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/cdcoonce/Portfolio_Website/tree/HEAD/.claude/skills/readme-generator

Perguntar na sua IA favorita

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

Prévia

Do README da skill

Linguagem

Documentação

Gerador de README

Crie arquivos README.md polidos e completos para repositórios de código internos/da empresa, analisando o código-fonte real e fazendo perguntas direcionadas para esclarecimentos.

Por que essa habilidade existe

Um bom README é a porta de entrada para um repositório de código. Em projetos internos, especialmente, a falta de um README ou um README incompleto significa que cada novo membro da equipe perde horas tentando entender o que o projeto faz, como executá-lo e por onde começar. Essa habilidade automatiza o trabalho pesado — ela lê o código, infere o que pode, pergunta sobre o que não consegue inferir e produz um README que deixa os desenvolvedores produtivos rapidamente.

Fluxo de Trabalho

Etapa 1: Analisar o código-fonte

Antes de perguntar qualquer coisa ao usuário, execute uma análise estruturada em quatro fases para reunir o máximo de contexto possível. Isso reduz a carga sobre o usuário — ele só precisa preencher lacunas, não descrever coisas que você já pode ver.

Etiquete cada fato com um nível de confiança: [confirmado] (lido da fonte), [inferido-alto] (evidência forte), [inferido-baixo] (evidência parcial) ou [desconhecido]. Descobertas de baixa confiança e desconhecidas se tornam perguntas de esclarecimento na Etapa 2.

Consulte referências/fases-de-analise.md para obter ações de ferramentas detalhadas, padrões de grep, checklists de extração e modelos de registro.

Fase 1 — Varredura de Metadados do Projeto: Faça glob para arquivos de gerenciador de pacotes (pyproject.toml, package.json, etc.), templates de ambiente, Dockerfiles, configurações de CI/CD e arquivos de toolchain. Leia cada um e extraia: nome/versão do projeto, linguagem, dependências (categorizadas com propósitos), scripts/comandos, variáveis de ambiente (obrigatórias vs. opcionais), estágios de CI, licença.

Fase 2 — Varredura de Arquitetura: Faça glob para todos os arquivos fonte para mapear a estrutura de diretórios. Use grep para identificar marcadores de ponto de entrada (if __name__, main(), etc.) e leia cada ponto de entrada. Construa o gráfico de importações usando grep para instruções de importação em todos os arquivos fonte — classifique os módulos como core (alto grau de entrada), folha ou orquestrador. Identifique o padrão de arquitetura (pipeline, MVC, camadas, microsserviços, orientado a eventos, CLI, monolito) usando a checklist de indicadores. Use grep para encontrar padrões de carregamento de configuração, a fim de localizar arquivos de configuração em tempo de execução.

Fase 3 — Análise Profunda de Módulos: Leia cada arquivo fonte significativo (priorizados: core → ponto de entrada → maiores → restante). Para cada um, extraia: propósito (uma frase), exports chave com assinaturas, notas de design (decisões não óbvias, casos de borda, convenções) e dependências internas. Rastreie o fluxo de trabalho principal de ponta a ponta através do gráfico de importações, rotulando quais tipos de dados fluem entre os módulos. Para bases de código com 8 ou mais arquivos fonte, despache subagentes paralelos agrupados por cluster de dependências.

Fase 4 — Varredura de Infraestrutura de Suporte: Faça glob para arquivos de teste e fixtures. Leia as primeiras 30-50 linhas de cada arquivo de teste para construir um mapeamento teste-para-módulo. Use grep para classes de exceção personalizadas e instruções raise para mapear a hierarquia de erros. Varra templates, assets e documentação existente. Extraia cenários de erro comuns para a tabela de Solução de Problemas.

Etapa 2: Fazer perguntas esclarecedoras

Após a análise, pergunte ao usuário sobre coisas que você não conseguiu inferir com confiança. Mantenha o foco — não pergunte sobre coisas que você já sabe. Lacunas comuns incluem:

  • Propósito do projeto: Qual problema ele resolve? Quem o usa? (se não estiver óbvio pelo código)
  • Pegadinhas de configuração: Existem pré-requisitos não óbvios, requisitos de VPN, registros de pacotes internos ou etapas de configuração de banco de dados?
  • Fluxos de trabalho principais: Quais são as 2-3 coisas que um desenvolvedor faz com mais frequência neste projeto?
  • Implantação: Como/onde isso é implantado? (se não estiver claro nas configurações de CI/CD)
  • Convenções da equipe: Existem convenções de nomenclatura, estratégias de branch ou padrões a serem mencionados?
  • Informações de contato: Quem é o proprietário/mantenedor deste projeto? (nome + email para a seção de Contato)

Apresente suas perguntas de forma concisa. Se o código for direto e você estiver confiante em sua análise, pode precisar de apenas 1-2 perguntas — ou mesmo nenhuma. Use seu julgamento.

Etapa 3: Gerar o README.md

Escreva o README usando a estrutura e as diretrizes abaixo.

Estrutura do README

Use este como seu modelo. Inclua todas as seções, mas ajuste a profundidade de acordo com a complexidade do projeto. Use réguas horizontais --- entre cada seção principal para dar respiro visual.

# Nome do Projeto

![Linguagem](https://img.shields.io/badge/...) ![Framework](https://img.shields.io/badge/...) ![Ferramenta](https://img.shields.io/badge/...)

Descrição breve e clara. Use **negrito** para destacar a tecnologia chave ou o tipo de produto.

---

## Índice

Gere um índice completo e aninhado que inclua TODOS os cabeçalhos ## e ###. Recue as subseções sob suas seções pai para que os leitores possam ver a estrutura completa de relance. Isso é especialmente importante em READMEs mais longos — o índice serve tanto como uma ferramenta de navegação quanto como um esboço de todo o documento.

Exemplo da profundidade esperada:

- [Visão Geral](#visão-geral)
- [Arquitetura](#arquitetura)
  - [Arquitetura de Alto Nível](#arquitetura-de-alto-nível)
  - [Estrutura de Pastas](#estrutura-de-pastas)
  - [Grafo de Dependências de Módulos](#grafo-de-dependências-de-módulos)
- [Primeiros Passos](#primeiros-passos)
  - [Pré-requisitos](#pré-requisitos)
  - [Instalação](#instalação)
  - [Executando Testes](#executando-testes)
- [Variáveis de Ambiente](#variáveis-de-ambiente)
- [Uso](#uso)
  - [Exemplo: Caso de Uso Principal](#exemplo-caso-de-uso-principal)
  - [Exemplo: Caso de Uso Secundário](#exemplo-caso-de-uso-secundário)
- [Referência da API](#referência-da-api)
  - [Recurso A](#recurso-a)
  - [Recurso B](#recurso-b)
- [Solução de Problemas](#solução-de-problemas)
- [Contato](#contato)
- [Licença](#licença)

Cada cabeçalho ### no documento deve aparecer como uma entrada recuada sob seu cabeçalho ## pai. Não pule subseções — o objetivo de um índice completo é que os leitores possam pular diretamente para qualquer parte do documento.

---

## Visão Geral

Expanda a descrição. Coloque termos chave em negrito. Use listas numeradas para processos de várias etapas.

---

## Arquitetura

### Arquitetura de Alto Nível

```mermaid
graph TD
    ...

### Estrutura de Pastas

raiz-do-projeto/ ├── src/ # Breve anotação ├── tests/ # Breve anotação └── ...


### [Fluxo de Dados / Pipeline / Dependências de Módulos — diagramas adicionais]

```mermaid
...

Primeiros Passos

Pré-requisitos

Instalação

Executando Testes


Variáveis de Ambiente

VariávelObrigatóriaDescrição
DB_URLSimString de conexão PostgreSQL

Uso

Exemplos de código reais para as 2-3 operações mais comuns.


Referência da API


Solução de Problemas

SintomaCausa ProvávelCorreção
mensagem de erroO que está erradoComo corrigir

Contato

Para perguntas ou suporte, entre em contato:


Licença

Uso Interno Apenas – Nome da Empresa Software proprietário. © [Ano] [Empresa]. Todos os direitos reservados.


## Badges do Shields.io

Sempre inclua badges do shields.io logo após o título `# Nome do Projeto` (3-6 badges cobrindo linguagem, framework, biblioteca principal, gerenciador de pacotes, banco de dados, infraestrutura). Consulte [referências/referencia-de-badges.md](referências/referencia-de-badges.md) para obter formato, exemplos e sugestões de cores por categoria.

## Diretrizes para Diagramas Mermaid

Use diagramas Mermaid generosamente — eles tornam a arquitetura, os fluxos de dados e os processos imediatamente compreensíveis. Um README típico deve ter **3-6 diagramas**; projetos complexos (pipelines de dados, sistemas com vários serviços) podem ter **6-10+**. Consulte [referências/diretrizes-mermaid.md](referências/diretrizes-mermaid.md) para saber quando usar cada tipo de diagrama, melhores práticas e recomendações específicas por tipo de projeto.

## Diretrizes de Escrita

- **Seja específico em vez de genérico.** "Execute `npm run dev`" é melhor do que "Inicie o servidor de desenvolvimento." Inclua comandos reais, caminhos de arquivos e nomes de variáveis.
- **Escreva para o novo membro da equipe.** Presuma habilidades gerais de engenharia, mas zero contexto do projeto.
- **Coloque em negrito termos chave e nomes de produtos** na primeira menção e nas visões gerais. Isso ajuda os leitores a escanear.
- **Use listas numeradas para processos sequenciais.** "1. **Extrai** dados de X. 2. **Transforma** os dados. 3. **Carrega** em Y." — coloque o verbo em negrito.
- **Exemplos de código devem ser executáveis.** Copie do código real sempre que possível.
- **Tabelas de variáveis de ambiente são inegociáveis.** Liste cada uma delas.
- **Solução de problemas em formato de tabela** (Sintoma | Causa Provável | Correção) — escaneável e consistente.
- **Anotações da estrutura de pastas devem ser breves.** Uma frase curta por diretório.
- **Sempre inclua uma seção de Contato.** Pergunte ao usuário quem mantém o projeto. Formato: `**Nome** — [email protected]`.
- **Use réguas horizontais `---`** entre todas as seções principais para estrutura visual.

## Saída

Salve o README como `README.md` na raiz do repositório (ou no diretório de trabalho atual se nenhuma raiz do repositório for identificável). Se um `README.md` já existir, confirme com o usuário antes de sobrescrever — ele pode querer manter partes dele.

Individual skills in this repo

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

cdcoonce/Portfolio_Website

Git commit workflow with enforced conventional commit style. Use when Claude needs to stage and commit changes, craft commit messages, or the user asks to commit, make a commit, or save their work. Ensures consistent commit message format, proper scoping, and atomic commits across the project.

cdcoonce/Portfolio_Website

AI-powered code quality analysis for Python, Markdown, and Mermaid diagrams. Use this skill when: (1) reviewing code for quality issues, (2) checking Python files for PEP8 violations, unused code, missing type hints, docstring problems, complexity issues, or potential runtime errors, (3) validating Markdown documentation for broken links, heading structure, or formatting issues, (4) validating Mermaid diagram syntax, (5) the user asks for a "code review" or "quality check", (6) analyzing code snippets pasted in conversation, or (7) suggesting and applying fixes for code quality issues.

cdcoonce/Portfolio_Website

Deploy the portfolio chat agent Lambda function to AWS. Use when the user asks to deploy, redeploy, push to Lambda, update the chat agent, or after updating context files or lambda_function.py. Rebuilds the knowledge base, packages dependencies, and deploys to AWS Lambda.

cdcoonce/Portfolio_Website

Generate multiple radically different interface designs for a module using parallel sub-agents. Use when user wants to design an API, explore interface options, compare module shapes, or mentions "design it twice".

cdcoonce/Portfolio_Website

Orchestrate the full GitHub-issues-driven development lifecycle. 7-phase pipeline from brainstorm through PR with state tracking and cross-conversation resume. Use when user says "dev cycle", "development workflow", "full development pipeline", or invokes /dev-cycle.

cdcoonce/Portfolio_Website

Production Python coding standards with automatic version detection (3.10-3.13). Use when writing, reviewing, or refactoring Python to ensure adherence to modern type syntax, LBYL exception handling, pathlib operations, ABC-based interfaces, and production-tested patterns. Not Dagster-specific - applies to any Python project.

cdcoonce/Portfolio_Website

Set up Claude Code hooks to block dangerous git commands (push, reset --hard, clean, branch -D, etc.) before they execute. Use when user wants to prevent destructive git operations, add git safety hooks, or block git push/reset in Claude Code.

cdcoonce/Portfolio_Website

GitHub CLI (gh) integration for managing issues, pull requests, branches,

cdcoonce/Portfolio_Website

Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".

cdcoonce/Portfolio_Website

Explore a codebase to find opportunities for architectural improvement, focusing on making the codebase more testable by deepening shallow modules. Use when user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more AI-navigable.

cdcoonce/Portfolio_Website

CEO/founder-mode plan review. Rethink the problem, find the 10-star product, challenge premises, expand scope when it creates a better product. Three modes: SCOPE EXPANSION (dream big), HOLD SCOPE (maximum rigor), SCOPE REDUCTION (strip to essentials). Use when the user asks for a plan review, CEO review, mega review, or wants a plan challenged/stress-tested before implementation.

cdcoonce/Portfolio_Website

Break a PRD into independently-grabbable GitHub issues using tracer-bullet vertical slices. Use when user wants to convert a PRD to issues, create implementation tickets, or break down a PRD into work items.

cdcoonce/Portfolio_Website

Turn a PRD into a multi-phase implementation plan using tracer-bullet vertical slices, saved as a local Markdown file in docs/plans/. Use when user wants to break down a PRD, create an implementation plan, plan phases from a PRD, or mentions "tracer bullets".

cdcoonce/Portfolio_Website

Generate or update the `.claude/docs/project.md` file that gives Claude project-specific context. Use this skill when the user asks to create, update, regenerate, or refresh project context, or says things like "update project.md", "generate project context", "this repo needs a project.md", or "Claude doesn't know about this project". Also trigger when onboarding Claude to a new repository for the first time.

cdcoonce/Portfolio_Website

Create a detailed refactor plan with tiny commits via user interview, then file it as a GitHub issue. Use when user wants to plan a refactor, create a refactoring RFC, or break a refactor into safe incremental steps.

cdcoonce/Portfolio_Website

Set up pre-commit hooks for the current repo. Use when user wants to add pre-commit hooks, configure commit-time linting, formatting, type checking, or testing. Triggers on "pre-commit", "git hooks", "linting hooks", or /setup-pre-commit.

cdcoonce/Portfolio_Website

Test-driven development with red-green-refactor loop. Use when user wants to build features or fix bugs using TDD, mentions "red-green-refactor", wants integration tests, or asks for test-first development.

cdcoonce/Portfolio_Website

Triage a bug or issue by exploring the codebase to find root cause, then create a GitHub issue with a TDD-based fix plan. Use when user reports a bug, wants to file an issue, mentions "triage", or wants to investigate and plan a fix for a problem.

cdcoonce/Portfolio_Website

Rewrites the prose sections of wiki pages in-place. Reads source files to understand current context, then updates only the content inside <!-- claude:prose --> ... <!-- claude:prose:end --> markers. Never touches <!-- generated:start --> ... <!-- generated:end --> blocks. Supports targeting a single page with /update-wiki {PageName}.

cdcoonce/Portfolio_Website

Create a PRD through user interview, codebase exploration, and module design, then submit as a GitHub issue. Use when user wants to write a PRD, create a product requirements document, or plan a new feature.

Habilidades Relacionadas