O README Sync automatiza atualizações da documentação do projeto antes e depois das alterações de código para garantir que o contexto do projeto esteja sempre preciso e com uso eficiente de Token.
Instalar e Baixar
1. ClawHub CLI
A maneira mais rápida de instalar uma habilidade diretamente do registro.
npx clawhub@latest install readme-sync
2. Instalação Manual
Copie a pasta da habilidade para um desses locais
~/.openclaw/skills/ <project>/skills/ Prioridade: Espaço de Trabalho > Local > Integrado
3. Instalação do Prompt
Copie este prompt para o OpenClaw para instalá-lo automaticamente.
Ajude-me a instalar o readme-sync usando o Clawhub. Se o Clawhub não estiver instalado, instale-o primeiro (npm i -g clawhub).
Prefere baixar?
Obtenha os arquivos originais da habilidade em um arquivo ZIP.
O que é README Sync?
O README Sync é uma ferramenta sofisticada projetada para que agentes de codificação de IA mantenham a integridade da documentação do projeto. Ele garante que o arquivo README.md reflita com precisão o estado atual de um projeto, lendo o contexto antes do início do trabalho e sincronizando as alterações assim que as tarefas são concluídas. Ao oferecer suporte a uma estratégia de carregamento sob demanda, ele minimiza o consumo de Token enquanto maximiza a compreensão da IA sobre pilhas tecnológicas, estruturas de projeto e modificações recentes.
Esta Skill é compatível com várias plataformas, incluindo Claude Code, Openclaw Skills, Trae e Cursor. Ela atua como uma ponte entre a implementação real do código e a documentação de alto nível, tornando mais fácil para humanos e agentes de IA retomarem o trabalho de onde pararam sem precisar vasculhar logs complexos do git.
Casos de uso do README Sync
- Atualização automática de logs de alterações e marcos de progresso após a implementação de novos recursos.
- Inicialização de um README.md para um projeto legado através da verificação de estruturas de diretórios e pilhas tecnológicas.
- Leitura sob demanda de seções específicas da documentação para economizar Token durante interações com IA.
- Registro de 'armadilhas' ou problemas comuns descobertos durante a depuração para evitar erros futuros.
- Manutenção de uma tabela organizada de modificações recentes para revisões rápidas da equipe.
Como o README Sync funciona
- Inicialização de Contexto: Antes de iniciar uma tarefa, o agente lê o README.md usando uma abordagem de linha de base mínima (Posicionamento e Estrutura do Projeto) para entender o ambiente.
- Expansão Sob Demanda: Dependendo da tarefa (correção de bug, alteração de API, etc.), o agente lê seções adicionais relevantes, como pilhas tecnológicas ou visões gerais de API.
- Cache Incremental: À medida que o trabalho progride, o agente identifica alterações dignas de nota (novos recursos, bugs corrigidos) e as armazena localmente usando a ferramenta CLI.
- Confirmação do Usuário: Após a conclusão da tarefa ou ao atingir um limite de cache, o agente apresenta um resumo das atualizações pendentes ao usuário.
- Atualização Sincronizada: Uma vez confirmada pelo usuário, a ferramenta executa uma gravação incremental no README.md, preservando a formatação e a estrutura existentes.
Configuração do README Sync
Para começar a usar esta Skill, certifique-se de que você tenha o Python instalado e o script de operação disponível em seu projeto:
# Inicializar um novo README se não existir
python scripts/readme_operations.py auto-init
# Verificar o status atual das atualizações pendentes
python scripts/readme_operations.py pending
# Sincronizar alterações em cache com o arquivo README.md
python scripts/readme_operations.py sync
Esquema de Dados e Taxonomia de README Sync
A Skill organiza informações em seções Markdown padronizadas para garantir compatibilidade entre plataformas com o Openclaw Skills e outros IDEs:
| Seção | Descrição | Tipo de Dado |
|---|---|---|
| Posicionamento do Projeto | Resumo de 1-2 linhas sobre o propósito do projeto | Texto |
| Pilha Tecnológica | Lista de linguagens, frameworks e bancos de dados | Lista |
| Estrutura do Projeto | Árvore de diretórios visual (ex: src/, tests/) | Bloco de Código |
| Progresso | Lista de verificação de tarefas concluídas e planejadas | Lista de Verificação Markdown |
| Registros de Armadilhas | Avisos e soluções para problemas comuns | Lista com Ícones |
| Modificações Recentes | Tabela das últimas 10 alterações (Data, Conteúdo, Arquivos) | Tabela Markdown |
Recursos avançados do README Sync
- Otimização de Token: Implementa uma estratégia de carregar apenas o necessário, reduzindo significativamente os custos para sessões de IA de longa duração.
- Suporte Multiplataforma: Adaptado para funcionar perfeitamente com as configurações do .cursorrules, CLAUDE.md e Openclaw Skills.
- Varredura Automatizada de Diretórios: Usa auto-init para gerar estruturas de projeto e listas de pilhas tecnológicas sem entrada manual.
- Sincronização Interativa: Oferece gatilhos manuais como
/readme synce/readme diffpara um controle granular sobre as atualizações da documentação.
SKILL.md
Carregamento
Habilidades relacionadas do Openclaw
Memory Secretary
Um assistente inteligente leve e sem dependências, projetado para gerenciar, otimizar e extrair insights de arquivos de memória de um AI agent.
Marrow
Uma camada de memória persistente que permite aos AI agents registrar decisões, revelar falhas passadas e acumular inteligência em múltiplas sessões.
Gerador de Conteúdo Multiplataforma
Um motor automatizado para gerar ativos visuais e textos de marketing específicos para plataformas, adaptados para as principais redes sociais.
Automação de Conteúdo para Conta Oficial do WeChat
Um fluxo de trabalho automatizado para gerar e publicar conteúdo multimídia diretamente na caixa de rascunhos da Conta Oficial do WeChat.
TikTok Android Bot
Uma ferramenta de automação para TikTok no Android via ADB, que utiliza visão computacional por IA para gerar comentários inteligentes e gerenciar o engajamento de vídeos.
knowledge-workflow
Um sistema abrangente de gestão de conhecimento orientado por IA que transforma informações brutas de várias fontes em conteúdo publicado de alta qualidade.
Apresentou*
