Pular para o conteúdo
Skillpedia
Escrita40 mil · #5409

update-specification

Atualiza arquivos de especificação para IA. Otimiza o conteúdo para que modelos de IA possam entendê-lo e usá-lo melhor.

O que ela faz

Esta ferramenta atualiza um arquivo de especificação existente. Ela garante que as regras e detalhes de um projeto de software estejam claros e bem organizados para que outras ferramentas de IA possam entendê-los facilmente.

Quando usar

  • ✓Quando um projeto de software precisa ter suas regras e detalhes documentados.
  • ✓Quando as regras de um projeto de software mudam e a documentação precisa ser atualizada.
  • ✓Quando você quer garantir que a documentação do seu projeto seja fácil para outras IAs entenderem.

Exemplo do que pedir para a IA

“Atualize a especificação do arquivo 'api-gateway.md' com as novas regras de autenticação.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/github/awesome-copilot/blob/main/skills/update-specification/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/github/awesome-copilot/blob/main/skills/update-specification/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

A ferramenta pega o arquivo de especificação que você indicar e o modifica seguindo as melhores práticas. Ela organiza as informações de forma clara, usando títulos, listas e evitando linguagem ambígua, para que a IA possa processar tudo corretamente.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add github/awesome-copilot --skill update-specification

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/update-specification/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Especificação de Atualização

Seu objetivo é atualizar o arquivo de especificação existente ${file} com base em novos requisitos ou atualizações em qualquer código existente.

O arquivo de especificação deve definir os requisitos, restrições e interfaces para os componentes da solução de forma clara, inequívoca e estruturada para uso eficaz por IA Generativa. Siga os padrões de documentação estabelecidos e garanta que o conteúdo seja legível por máquina e autossuficiente.

Melhores Práticas para Especificações Prontas para IA

  • Use linguagem precisa, explícita e inequívoca.
  • Distinga claramente entre requisitos, restrições e recomendações.
  • Use formatação estruturada (títulos, listas, tabelas) para facilitar a análise.
  • Evite expressões idiomáticas, metáforas ou referências dependentes de contexto.
  • Defina todas as siglas e termos específicos do domínio.
  • Inclua exemplos e casos extremos, quando aplicável.
  • Garanta que o documento seja autossuficiente e não dependa de contexto externo.

A especificação deve ser salva no diretório /spec/ e nomeada de acordo com a seguinte convenção: [a-z0-9-]+.md, onde o nome deve ser descritivo do conteúdo da especificação e começar com o propósito de alto nível, que é um de [schema, tool, data, infrastructure, process, architecture, ou design].

O arquivo de especificação deve ser formatado em Markdown bem formado.

Os arquivos de especificação devem seguir o modelo abaixo, garantindo que todas as seções sejam preenchidas adequadamente. O front matter do markdown deve ser estruturado corretamente conforme o exemplo a seguir:

---
title: [Título Conciso Descrevendo o Foco da Especificação]
version: [Opcional: ex: 1.0, Data]
date_created: [AAAA-MM-DD]
last_updated: [Opcional: AAAA-MM-DD]
owner: [Opcional: Equipe/Indivíduo responsável por esta especificação]
tags: [Opcional: Lista de tags ou categorias relevantes, ex: `infrastructure`, `process`, `design`, `app` etc]
---

# Introdução

[Uma breve introdução concisa à especificação e ao objetivo que ela pretende alcançar.]

## 1. Propósito e Escopo

[Forneça uma descrição clara e concisa do propósito da especificação e do escopo de sua aplicação. Indique o público-alvo e quaisquer suposições.]

## 2. Definições

[Liste e defina todas as siglas, abreviações e termos específicos do domínio usados nesta especificação.]

## 3. Requisitos, Restrições e Diretrizes

[Liste explicitamente todos os requisitos, restrições, regras e diretrizes. Use marcadores ou tabelas para clareza.]

- **REQ-001**: Requisito 1
- **SEC-001**: Requisito de Segurança 1
- **[3 LETRAS]-001**: Outro Requisito 1
- **CON-001**: Restrição 1
- **GUD-001**: Diretriz 1
- **PAT-001**: Padrão a seguir 1

## 4. Interfaces e Contratos de Dados

[Descreva as interfaces, APIs, contratos de dados ou pontos de integração. Use tabelas ou blocos de código para esquemas e exemplos.]

## 5. Critérios de Aceitação

[Defina critérios de aceitação claros e testáveis para cada requisito, usando o formato Dado-Quando-Então onde apropriado.]

- **AC-001**: Dado [contexto], Quando [ação], Então [resultado esperado]
- **AC-002**: O sistema deve [comportamento específico] quando [condição]
- **AC-003**: [Critérios de aceitação adicionais conforme necessário]

## 6. Estratégia de Automação de Testes

[Defina a abordagem de testes, frameworks e requisitos de automação.]

- **Níveis de Teste**: Unitário, Integração, End-to-End
- **Frameworks**: MSTest, FluentAssertions, Moq (para aplicações .NET)
- **Gerenciamento de Dados de Teste**: [abordagem para criação e limpeza de dados de teste]
- **Integração CI/CD**: [testes automatizados em pipelines do GitHub Actions]
- **Requisitos de Cobertura**: [limiares mínimos de cobertura de código]
- **Testes de Desempenho**: [abordagem para testes de carga e desempenho]

## 7. Racional e Contexto

[Explique o raciocínio por trás dos requisitos, restrições e diretrizes. Forneça contexto para as decisões de design.]

## 8. Dependências e Integrações Externas

[Defina os sistemas externos, serviços e dependências arquiteturais necessários para esta especificação. Concentre-se em **o que** é necessário em vez de **como** é implementado. Evite versões específicas de pacotes ou bibliotecas, a menos que representem restrições arquiteturais.]

### Sistemas Externos
- **EXT-001**: [Nome do sistema externo] - [Propósito e tipo de integração]

### Serviços de Terceiros
- **SVC-001**: [Nome do serviço] - [Capacidades necessárias e requisitos de SLA]

### Dependências de Infraestrutura
- **INF-001**: [Componente de infraestrutura] - [Requisitos e restrições]

### Dependências de Dados

…
Perguntas frequentes

O que é um arquivo de especificação?

É um documento que descreve detalhadamente como um software ou parte dele deve funcionar, incluindo regras, restrições e como ele se comunica com outras partes.

Por que a documentação precisa ser 'otimizada para IA'?

Para que ferramentas de inteligência artificial possam ler, entender e usar as informações de forma eficiente, sem confusão ou interpretações erradas.

Que tipo de informação vai nesse arquivo?

Requisitos (o que o software deve fazer), restrições (o que ele não pode fazer ou como deve ser feito), interfaces (como ele se conecta com outros sistemas), critérios de aceitação (como saber se está funcionando certo) e mais.

Detalhes

Descrição original do autor

Update an existing specification file for the solution, optimized for Generative AI consumption based on new requirements or updates to any existing code.

repo: github/awesome-copilot

Popularidade

Estrelas no GitHub
40 mil
Posição no ranking
#5409
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas