AGENT SKILL

rdd-scope-agreement

Gera SCOPE_AGREEMENT.md — documento de alinhamento com o cliente em linguagem de negócio. Unifica escopo, RNs confirmadas, histórico de mudanças e status de aprovação. Deve ser atualizado a cada novo lote de requisitos ou CR aprovado. Use quando o usuário pedir "acordo de escopo", "documento de alinhamento com o cliente" ou "atualizar SCOPE_AGREEMENT.md".

License 许可
Apache-2.0
最近更新
2026-11-04
Stars
★ 4
Forks
1

01 前言 Front Matter

name
rdd-scope-agreement
description
Gera SCOPE_AGREEMENT.md — documento de alinhamento com o cliente em linguagem de negócio. Unifica escopo, RNs confirmadas, histórico de mudanças e status de aprovação. Deve ser atualizado a cada novo lote de requisitos ou CR aprovado. Use quando o usuário pedir "acordo de escopo", "documento de alinhamento com o cliente" ou "atualizar SCOPE_AGREEMENT.md".

03 SKILL.md 正文

rdd-scope-agreement — Acordo de Escopo com o Cliente

Gera <modulo>/<projeto>/delivery/SCOPE_AGREEMENT.md — um documento vivo em linguagem de negócio que serve como contrato de comprometimento entre a equipe técnica e o cliente.

Referências

  • RNs em linguagem de negócio (fonte): docs/CONSTITUTION.md §13
  • Estrutura de pastas: docs/CONSTITUTION.md §15

Resolução de caminhos (IMP-011)

Os artefatos do módulo seguem a estrutura com subpastas (IMP-011):

  • Raiz: PROJECT_CHARTER.md, CONSTITUTION.md, REQUIREMENTS.md, DECISIONS.md, CHANGELOG.md
  • specs/: DATA_MODEL.md, API_CONTRACTS.md, ERROR_CATALOG.md, UI_SPEC.md, ARCHITECTURE.md, SECURITY.md, ACCEPTANCE_CRITERIA.md, USER_STORIES.md, US<NNN>.md, FIGMA_PROMPTS.md, COMPLIANCE.md
  • quality/: TEST_STRATEGY.md, DEFINITION_OF_DONE.md, TRACEABILITY.md, VALIDATION_REPORT.md, PROPAGATION_STATUS.md, PROGRESS_REPORT.md
  • delivery/: TASKS.md, TASKS_.md, TASKS_AZURE_CONSOLIDADO.md, SCOPE_AGREEMENT.md, CLIENT_REQUIREMENTS.md, CLIENT_REPORT_.md, HANDOVER_LOG.md
  • support/: LEGACY_CONTEXT.md, KNOWN_ERRORS.md, MIGRATION.md, CHANGE_REQUESTS.md
  • glossaries/: DEV_GLOSSARY.md, BUSINESS_GLOSSARY.md, USER_GLOSSARY.md, GLOSSARY.md
  • docs/: howto/*.md e documentos auxiliares
  • meetings/, contracts/: checkpoints (inalterados)

Regra de fallback (transição): ao LER um artefato, verifique primeiro o caminho novo (ex: specs/DATA_MODEL.md); se não existir, use o caminho legado na raiz do módulo (ex: DATA_MODEL.md). Ao ESCREVER/GERAR, use sempre o caminho novo. Módulos ainda não migrados via rdd-restructure continuam legíveis durante a transição.

Lê (upstream)

  • <modulo>/<projeto>/PROJECT_CHARTER.md (identificação, escopo, riscos)
  • <modulo>/<projeto>/REQUIREMENTS.md (RNs, PENDs, decisões)
  • <modulo>/<projeto>/support/CHANGE_REQUESTS.md (mudanças solicitadas e aprovadas; fallback: raiz)
  • <modulo>/<projeto>/CHANGELOG.md (histórico de adições/alterações)
  • <modulo>/<projeto>/specs/US<NNN>.md (se existir, para linguagem do usuário; fallback: raiz)
  • <modulo>/<projeto>/delivery/SCOPE_AGREEMENT.md (se existir, para merge incremental; fallback: raiz)

Gera (downstream)

  • <modulo>/<projeto>/delivery/SCOPE_AGREEMENT.md

Nunca edita

  • REQUIREMENTS.md
  • PROJECT_CHARTER.md
  • Nenhum documento técnico ou de requisitos

Tools

  • read (ler documentos upstream)
  • write (escrever SCOPE_AGREEMENT.md)
  • grep (buscar RNs, CRs, DECs)

Modo de erro

continue — se falhar, loga warning. É documento de comunicação, não bloqueia o fluxo técnico.

Algoritmo

  1. Leia REQUIREMENTS.md, support/CHANGE_REQUESTS.md, CHANGELOG.md e o SCOPE_AGREEMENT.md existente (se houver)
  2. Traduza RNs e mudanças para linguagem de negócio — sem IDs internos visíveis no texto principal (IDs só na seção de rastreamento)
  3. Se o documento existe, faça merge incremental (seções adicionam itens, CRs aprovados refletem, pendências resolvidas saem); se não, gere todas as seções do template
  4. Atualize a data e o status da versão (proposta | vigente)
  5. Escreva delivery/SCOPE_AGREEMENT.md

Formato de commit

docs: update scope agreement for <projeto>

Regras

  1. Linguagem de negócio — NUNCA use EARS, termos técnicos ou IDs internos (RN-XXX) no texto principal. Use paráfrases claras. Os IDs internos devem ficar em nota de rodapé ou coluna separada apenas na seção de rastreamento.

  2. Mercado-alvo da linguagem: o stakeholder de negócio que aprovou o projeto — não o usuário final, não o desenvolvedor.

  3. Última versão sempre substitui a anterior — o SCOPE_AGREEMENT.md é o documento mais atualizado. Não mantém versões históricas no mesmo arquivo (o CHANGELOG.md cuida disso).

  4. Se existir, faça merge incremental — preserve seções que o cliente já aprovou, adicione apenas o novo lote.

Template — SCOPE_AGREEMENT.md

---
project: <NOME>
module: escopo
audience: [negocio]
status: draft
---
# Acordo de Escopo — [Nome do Sistema]

> **Cliente:** [nome do contratante]
> **Última atualização:** DD/MM/AAAA
> **Status da versão:** proposta | vigente

---

## 1. Objetivo do Projeto

[parágrafo em linguagem de negócio — o problema que o sistema resolve]

## 2. O Que Será Entregue

### 2.1 [Tema/Funcionalidade 1]

- Item de escopo em linguagem clara
- Item de escopo em linguagem clara

### 2.2 [Tema/Funcionalidade 2]

- Item de escopo em linguagem clara

## 3. O Que Não Está no Escopo

- Item fora do escopo
- Item fora do escopo

## 4. Regras de Negócio Confirmadas

| # | Regra | Status |
|---|---|---|
| 1 | [descrição em linguagem de negócio] | ✅ confirmada |
| 2 | [descrição em linguagem de negócio] | 🔄 alterada em DD/MM |

> Os detalhes técnicos de cada regra estão em REQUIREMENTS.md.

## 5. Mudanças em Andamento

| # | Mudança | Status | Data |
|---|---|---|---|
| — | Nenhuma mudança pendente | — | — |

## 6. Pendências e Definições Futuras

| Item | Previsão |
|---|---|
| [pendência](/dúvida) | [data ou vazio] |

## 7. Riscos e Premissas

- [premissa/risco relevante para o cliente]

---

> Este documento é enviado ao cliente para leitura e aprovação verbal.
> Não substitui contrato formal — é uma ferramenta de alinhamento contínuo.

Seções que mudam a cada execução

Na primeira execução, gere todas as seções do template. Nas execuções seguintes (merge incremental):

  • §2 e §4 — adicione novos itens sem remover os existentes. Se uma RN foi alterada por CR, marque como 🔄 alterada em vez de reescrever.
  • §5 — CRs com status pending entram como pendentes; CRs approved entram como "em implementação"; CRs implemented são movidos para o CHANGELOG (seção §4 com status ✅ confirmada).
  • §6 — PENDs resolvidas desde a última execução são removidas.

Exemplo de §4 (RNs em linguagem de negócio)

## 4. Regras de Negócio Confirmadas

| # | Regra | Status |
|---|---|---|
| 1 | Toda propriedade rural deve ter um produtor responsável vinculado | ✅ confirmada |
| 2 | O sistema deve validar CPF/CNPJ do produtor no momento do cadastro | ✅ confirmada |
| 3 | Quando uma inspeção é agendada, o produtor recebe notificação com a data | ✅ confirmada |
| 4 | Inspeções podem ser registradas offline e sincronizam automaticamente | 🔄 alterada em 22/07 |

Casos de Borda

  • Primeira execução — gere todas as seções do template; não deixe seções vazias sem o placeholder.
  • CR implementado — mova a mudança para a seção de mudanças confirmadas com status ✅ confirmada e remova das pendentes.
  • CR pendente — mantenha como pendente; não antecipe aprovação.
  • RN alterada por CR — marque 🔄 alterada em DD/MM em vez de reescrever a linha.
  • PEND resolvida desde a última execução — remova da seção de pendências.

04 同仓库更多 Skills

victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-wiki-lint

Audita integridade dos artefatos RDD: contradições entre seções, artefatos órfãos, referências cruzadas quebradas, links internos inválidos e drift de estrutura. Complementa rdd-validate (que valida a DAG de RNs → downstreams) e rdd-decision-audit (que valida DECISIONS.md) com foco em integridade documental dos artefatos individualmente. Use quando o usuário pedir "lint dos documentos", "verificar integridade dos artefatos", "wiki lint", "contradições nos docs" ou "validar estrutura".

★ 4
victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-vps-troubleshoot

Diagnóstico guiado por sintoma para VPS da organização já configurada — container unhealthy / healthcheck expirando, GHCR denied/unauthorized no pull, git "could not read Username for 'https://github.com'", GitHub Actions (appleboy/ssh-action) falhando SSH (handshake failed, ParsePrivateKey), services systemd duplicados do cloudflared em activating (auto-restart), requisições caindo no servidor errado (tunnel compartilhado), porta ocupada, logs (journalctl / docker logs), conectividade (curl local vs público, ss, nc) e banco vazio / migrations não aplicadas. Base de conhecimento: runbook.md nesta pasta (sintomas genéricos de deploy em VPS; lições de produção da organização no pack `rules/<pack-da-organizacao>.md` — IMP-105). Modo guiado — sugere comandos com explicação; o operador executa na VPS. Use quando o usuário reportar "container unhealthy", "deploy falhou", "ssh action erro", "ghcr denied", "tunnel não responde", "banco vazio", "sem tabelas", "service duplicado", "vps com problema" ou pedir troubleshooting de deploy.

★ 4
victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-vps-setup

Wizard guiado de setup de VPS nova (OS do perfil — ex.: Amazon Linux) para hospedar uma API — atualização do sistema, Docker + Compose + buildx, permissões de arquivos, autenticação no registry do perfil (ex.: ghcr.io), git via SSH (deploy keys), chave SSH dedicada do GitHub Actions (appleboy/ssh-action), tunnel Cloudflare EXCLUSIVO por servidor + route DNS (domínio do perfil), tunnels como serviço systemd (autostart), logging do cloudflared com rotação, pipeline completo de deploy (push main → build → registry → ssh-action → deploy.sh) e backup automatizado (RClone + cronie + canal de alerta do perfil). Base de conhecimento validada: pack da organização em `rules/<pack-da-organizacao>.md` §infra-vps-setup (IMP-105). Modo guiado — sugere comandos com explicação; o operador executa na VPS. Use quando o usuário pedir "setup de VPS", "configurar VPS nova", "preparar servidor para deploy", "tunnel cloudflare", "ghcr", "deploy key", "backup rclone", "docker compose na vps" ou "pipeline de deploy na VPS".

★ 4
victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-validate

Percorre o grafo de documentos do projeto e valida integridade: RN sem downstream esperado, ID quebrado, CR aprovado sem reflexo. Gera relatório VALIDATION_REPORT.md. Suporta flag --fix para auto-correção. Use quando o usuário pedir "validar integridade", "checar a DAG", "validar referências cruzadas" ou "validação do módulo".

★ 4
victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-ui-spec

Gera UI_SPEC.md a partir das RNs em REQUIREMENTS.md. Descreve telas, componentes, fluxos de navegação, validações de frontend e regras de exibição condicional. Use quando o usuário pedir "especificação de UI", "spec de telas", "layout de formulários" ou "fluxo de navegação".

★ 4
victor-souza-dev
victor-souza-dev/RDD-CORE

rdd-ui-capture

Captura evidência visual em runtime do sistema legado para migração (golden master de UI) via MCP Playwright — screenshots por rota/estado, requisições de rede observadas e erros de console, gravados em reverse/ui/ com manifesto reverse/UI_CAPTURE.md e candidatas visuais na fila reverse/CANDIDATES.md. Complemento runtime da engenharia reversa estática (IMP-144). Use quando o usuário pedir "captura visual", "golden master de UI", "screenshots do legado", "captura de UI" ou "ui capture".

★ 4