| name | readme-manutencao |
| description | Skill para manter os READMEs do projeto sincronizados em PT-BR, EN e ZH. Use quando precisar atualizar documentação após implementações ou mudanças no projeto. |
Skill: Manutenção de README
Mantém os três READMEs do projeto (PT-BR, EN, ZH) sincronizados e atualizados.
Arquivos Gerenciados
| Arquivo | Idioma | Público |
|---|
README.md | 🇧🇷 Português | Principal |
README-en.md | 🇺🇸 English | Internacional |
README-zh.md | 🇨🇳 中文 | Chinês |
Quando Usar
- Após adicionar uma nova funcionalidade ao projeto
- Após criar novos agentes, skills ou prompts
- Quando o README está desatualizado em relação ao código
- Quando o usuário pede para "atualizar a documentação"
Regras de Sincronização
Conteúdo Obrigatório (todos os idiomas)
- Título e tagline do projeto
- Badges (License, GnuCOBOL, Copilot, PRs)
- Links de navegação entre idiomas
- Seção "O que é" / "What is" / "这是什么"
- Seção de funcionalidades/features
- Instruções de instalação (GnuCOBOL)
- Como usar (compilar + executar)
- Estrutura do projeto
- Como contribuir (link para CONTRIBUTING)
Regras de Tradução
PT-BR → EN:
- Manter tom casual e didático
- "Vibe Coding é programar sem entender o código" → "Vibe Coding is programming without understanding the code"
- Manter emojis idênticos
PT-BR → ZH (中文):
- Manter tom técnico mas acessível
- "Vibe Coding é programar sem entender o código" → "氛围编程就是在不理解代码的情况下编程"
- Adaptar culturalmente (não tradução literal)
Formato de Badges
[](./LICENSE)
[](https://gnucobol.sourceforge.io/)
[](https://github.com/features/copilot)
[](./CONTRIBUTING.md)
Navegação Entre Idiomas
Em README.md:
🇧🇷 Português | [🇺🇸 English](./README-en.md) | [🇨🇳 中文](./README-zh.md)
Em README-en.md:
[🇧🇷 Português](./README.md) | 🇺🇸 English | [🇨🇳 中文](./README-zh.md)
Em README-zh.md:
[🇧🇷 Português](./README.md) | [🇺🇸 English](./README-en.md) | 🇨🇳 中文
Sincronização de Exemplos de Código
Os READMEs podem conter blocos de código COBOL para ilustrar funcionalidades.
Esses blocos devem sempre refletir o código real em src/CALCULADORA.cbl.
Quando Verificar
- Sempre que o COBOL Coder modificar
src/CALCULADORA.cbl
- Quando novos parágrafos ou operações forem adicionados
- Quando nomes de variáveis forem alterados
Como Sincronizar
- Leia
src/CALCULADORA.cbl por completo
- Identifique todos os blocos
```cobol nos três READMEs
- Compare cada bloco com o código real:
- Nomes de variáveis (ex:
WS-NUMERO-1, WS-RESULTADO)
- Nomes de parágrafos (ex:
INICIO, PROCESSAR)
- Operações implementadas (ex:
ADD, SUBTRACT)
- Atualize os blocos desatualizados nos três idiomas simultaneamente
- Nunca invente código que não existe no arquivo
.cbl
- Prefira recortes reais do arquivo a exemplos genéricos
Exemplo de Verificação
Se o README mostra:
ADD WS-NUMERO-1 TO WS-NUMERO-2 GIVING WS-RESULTADO.
E o arquivo .cbl foi alterado para incluir subtração, adicione também:
SUBTRACT WS-NUMERO-2 FROM WS-NUMERO-1 GIVING WS-RESULTADO.
Processo de Atualização
- Leia
src/CALCULADORA.cbl — é a fonte da verdade do código
- Leia o
README.md (PT-BR) atual — é a fonte da verdade da documentação
- Identifique o que mudou no projeto (novos arquivos, features, estrutura, código)
- Atualize os exemplos de código COBOL nos READMEs para refletir o
.cbl atual
- Atualize o
README.md primeiro
- Traduza as mudanças para
README-en.md
- Traduza as mudanças para
README-zh.md
- Verifique que os links entre os arquivos funcionam
Checklist de Qualidade
