spec-first-copilot 0.7.0 → 0.8.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -0
- package/bin/cli.js +1 -1
- package/package.json +1 -1
- package/templates/.github/CHANGELOG.md +61 -0
- package/templates/.github/copilot-instructions.md +4 -2
- package/templates/.github/skills/sf-design/SKILL.md +161 -161
- package/templates/.github/skills/sf-dev/SKILL.md +204 -204
- package/templates/.github/skills/sf-discovery/SKILL.md +415 -415
- package/templates/.github/skills/sf-extract/SKILL.md +225 -225
- package/templates/.github/skills/sf-load/SKILL.md +296 -296
- package/templates/.github/skills/sf-mcp/SKILL.md +386 -386
- package/templates/.github/skills/sf-merge-docs/SKILL.md +152 -152
- package/templates/.github/skills/sf-onboard/SKILL.md +437 -0
- package/templates/.github/skills/sf-plan/SKILL.md +152 -152
- package/templates/.github/skills/sf-publish/SKILL.md +144 -144
- package/templates/.github/skills/sf-session-finish/SKILL.md +93 -93
- package/templates/.github/skills/sf-start/SKILL.md +192 -192
- package/templates/.github/templates/estrutura/decisions.template.md +140 -107
- package/templates/.github/templates/feature/TRD.template.md +450 -358
- package/templates/.github/templates/feature/context.template.md +118 -89
|
@@ -1,152 +1,152 @@
|
|
|
1
|
-
|
|
2
|
-
# /sf-merge-docs $ARGUMENTS
|
|
3
|
-
|
|
4
|
-
Skill atômica pós-dev. Aplica as decisões de **PRD + TRD aprovados** em `docs/` pra manter a síntese cross-feature sincronizada com o estado do sistema.
|
|
5
|
-
`$ARGUMENTS` = nome do scope (ex: `feat_cadastro_cliente`).
|
|
6
|
-
|
|
7
|
-
Chamado automaticamente pelo `/sf-dev` ao final. Re-executável manualmente quando precisa.
|
|
8
|
-
|
|
9
|
-
> **Mudança v3 → v4**: antes aplicava `SDD §11 Delta Specs` (mecanismo OpenSpec).
|
|
10
|
-
> Agora lê **PRD + TRD aprovados diretamente** e infere o delta comparando com
|
|
11
|
-
> o estado atual de `docs/` (diff semântico). SDD não existe mais em v4.
|
|
12
|
-
|
|
13
|
-
## Agente: Integrator (Opus)
|
|
14
|
-
|
|
15
|
-
Em v4 promovido de Sonnet → Opus: diff semântico PRD/TRD ↔ docs/ exige reasoning
|
|
16
|
-
de maior nível que o antigo "aplicar §11 explícito". Meticuloso com consistência.
|
|
17
|
-
Merge idempotente — re-aplicar os mesmos docs source não duplica conteúdo.
|
|
18
|
-
|
|
19
|
-
## Pré-condições
|
|
20
|
-
|
|
21
|
-
| # | Validação | Se falhar |
|
|
22
|
-
|---|-----------|-----------|
|
|
23
|
-
| 1 | `$ARGUMENTS` informado | Parar |
|
|
24
|
-
| 2 | `.context.md` com status `dev_done` (uso auto no /sf-dev) OU `design_done` a mais (uso manual) | Se anterior → "Rode /sf-design primeiro" |
|
|
25
|
-
| 3 | Pelo menos PRD.md OU TRD.md existe e está aprovado | Parar — "Nenhum doc source aprovado pra mergear" |
|
|
26
|
-
| 4 | `docs/` populado (veio de first-run anterior) | Parar — "/sf-design com first_run=true é quem cria docs/" |
|
|
27
|
-
|
|
28
|
-
> `/sf-merge-docs` **só se aplica a features**, não a first-run. Em first-run, é o
|
|
29
|
-
> próprio `/sf-design` que cria `docs/` a partir de PRD+TRD — não há o que mergear.
|
|
30
|
-
|
|
31
|
-
## Passos
|
|
32
|
-
|
|
33
|
-
### 1. Snapshot do estado atual de docs/
|
|
34
|
-
|
|
35
|
-
Ler `docs/{architecture,domain,conventions,apiContracts,decisions}.md`.
|
|
36
|
-
Indexar por elementos (tabelas, endpoints, ADRs, papéis, env vars...) pra diff.
|
|
37
|
-
|
|
38
|
-
### 2. Extrair elementos-destino do PRD e TRD aprovados
|
|
39
|
-
|
|
40
|
-
| Fonte (PRD/TRD) | Elemento | Destino em docs/ |
|
|
41
|
-
|-----------------|----------|------------------|
|
|
42
|
-
| TRD §1.1 Stack | Nova tecnologia / versão | `architecture.md` §Stack |
|
|
43
|
-
| TRD §1.2 Arquitetura | Novo container / padrão | `architecture.md` §Containers/Padrões |
|
|
44
|
-
| TRD §1.3 Ambientes | Novo ambiente / mudança | `architecture.md` §Ambientes |
|
|
45
|
-
| TRD §1.4 Deploy | Mudança na estratégia | `architecture.md` §Deploy |
|
|
46
|
-
| TRD §4 §Área-DB | Nova tabela / índice / FK | `domain.md` §Catálogo de Tabelas |
|
|
47
|
-
| TRD §2.1 Endpoints | Novo endpoint | `apiContracts.md` §Catálogo |
|
|
48
|
-
| TRD §7.1 Auth | Mudança em auth | `conventions.md` §Autenticação |
|
|
49
|
-
| TRD §7.2 Autorização | Novo papel / permissão | `conventions.md` §Autorização |
|
|
50
|
-
| TRD §7.3 LGPD | Novo dado pessoal | `conventions.md` §LGPD |
|
|
51
|
-
| TRD §7.4 Rate limit | Nova categoria | `conventions.md` §Rate Limiting |
|
|
52
|
-
| TRD §5.3 Env vars | Nova variável | `conventions.md` §Variáveis de Ambiente |
|
|
53
|
-
| TRD §6 Integrações | Novo sistema externo | `domain.md` §Integrações Externas |
|
|
54
|
-
| TRD §9 ADRs | Nova decisão | `decisions.md` (append-only, imutável) |
|
|
55
|
-
| PRD §2 Atores | Novo papel/persona | `domain.md` §Usuários e Papéis |
|
|
56
|
-
| PRD §5 RNs | Nova regra de negócio | (não vai pra docs/ — fica em specs/{nome}/contracts.md) |
|
|
57
|
-
|
|
58
|
-
> **Regra**: PRD alimenta poucas seções de `docs/` (só atores e alto-nível).
|
|
59
|
-
> O grosso vem do TRD — `docs/` é síntese técnica + negócio cross-feature.
|
|
60
|
-
|
|
61
|
-
### 3. Diff semântico: calcular ADDED / MODIFIED / REMOVED
|
|
62
|
-
|
|
63
|
-
Pra cada elemento-destino extraído (passo 2), comparar com snapshot (passo 1):
|
|
64
|
-
|
|
65
|
-
| Resultado | Condição | Ação |
|
|
66
|
-
|-----------|----------|------|
|
|
67
|
-
| ADDED | Elemento não existe em docs/ | Adicionar na seção apropriada |
|
|
68
|
-
| MODIFIED | Elemento existe mas mudou (nome igual, valor diferente) | Atualizar campos |
|
|
69
|
-
| UNCHANGED | Elemento existe e está igual | Skip (idempotente) |
|
|
70
|
-
| REMOVED | Elemento estava em docs/ mas não aparece em PRD+TRD aprovados | **NÃO remover** — apenas registrar no output como "possivelmente orfão" |
|
|
71
|
-
|
|
72
|
-
> **Conservadorismo em REMOVED**: PRD/TRD falam só da feature atual. Algo que
|
|
73
|
-
> "não aparece" pode ser de outra feature (que continua válida). NUNCA deletar
|
|
74
|
-
> automaticamente. Reportar e deixar remoção manual.
|
|
75
|
-
|
|
76
|
-
### 4. Aplicar ADDED e MODIFIED
|
|
77
|
-
|
|
78
|
-
- Localizar seção apropriada no doc destino
|
|
79
|
-
- Preservar estrutura do template (não quebrar tabelas)
|
|
80
|
-
- ADRs em `decisions.md`: SEMPRE append; ADR com status=aceita é imutável
|
|
81
|
-
- Registrar cada mudança em changelog do doc afetado
|
|
82
|
-
|
|
83
|
-
### 5. Changelog em cada doc afetado
|
|
84
|
-
|
|
85
|
-
Adicionar linha no `## Changelog` do doc:
|
|
86
|
-
|
|
87
|
-
```markdown
|
|
88
|
-
| Data | Feature | Tipo | Descrição |
|
|
89
|
-
|------|---------|------|-----------|
|
|
90
|
-
| {{ISO_DATE}} | $ARGUMENTS | ADDED | Endpoint POST /api/v1/users |
|
|
91
|
-
| {{ISO_DATE}} | $ARGUMENTS | MODIFIED | Matriz de permissões: novo role `manager` |
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### 6. Validar consistência cross-doc
|
|
95
|
-
|
|
96
|
-
- Referências quebradas (endpoint do apiContracts referencia tabela que não existe em domain) → reportar
|
|
97
|
-
- Papel novo em conventions mas não aparece em matriz de autorização → reportar
|
|
98
|
-
- ADR substituída mas ainda referenciada → reportar
|
|
99
|
-
|
|
100
|
-
Validação reporta, não bloqueia. Usuário decide se resolve manualmente.
|
|
101
|
-
|
|
102
|
-
### 7. Atualizar status
|
|
103
|
-
|
|
104
|
-
```yaml
|
|
105
|
-
status: "done"
|
|
106
|
-
ultima_skill: "/sf-merge-docs"
|
|
107
|
-
atualizado_em: "{{ISO_DATETIME}}"
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### 8. Saída obrigatória
|
|
111
|
-
|
|
112
|
-
```
|
|
113
|
-
/sf-merge-docs $ARGUMENTS — completo
|
|
114
|
-
|
|
115
|
-
docs/ sincronizado com PRD + TRD aprovados:
|
|
116
|
-
- docs/architecture.md (2 ADDED, 0 MODIFIED)
|
|
117
|
-
- docs/apiContracts.md (3 ADDED, 1 MODIFIED)
|
|
118
|
-
- docs/conventions.md (0 ADDED, 1 MODIFIED — novo role)
|
|
119
|
-
- docs/decisions.md (1 ADDED — ADR-007)
|
|
120
|
-
- docs/domain.md (0 mudanças)
|
|
121
|
-
|
|
122
|
-
Possivelmente órfãos (NÃO removidos — revisão manual):
|
|
123
|
-
- docs/apiContracts.md: endpoint `/legacy/foo` não aparece em PRD+TRD novos
|
|
124
|
-
(pode ser de outra feature; deletar manualmente se confirmado deprecated)
|
|
125
|
-
|
|
126
|
-
Validação: passed / N issues
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Erros
|
|
130
|
-
|
|
131
|
-
| Erro | Ação |
|
|
132
|
-
|------|------|
|
|
133
|
-
| Status != `dev_done` (auto) nem >= `design_done` (manual) | Parar — pedir rodar /sf-dev ou /sf-design primeiro |
|
|
134
|
-
| `docs/` não existe | Parar — explicar que `/sf-design` em first-run cria docs/ (feature só atualiza) |
|
|
135
|
-
| PRD+TRD sem nada novo vs docs/ | Marcar `done` (legítimo — feature sem impacto cross-feature) |
|
|
136
|
-
| Elemento MODIFIED não encontrado no doc | Converter pra ADDED + reportar (doc estava desatualizado) |
|
|
137
|
-
| Referências quebradas detectadas | Reportar, não bloqueia |
|
|
138
|
-
|
|
139
|
-
## Uso automático (pelo `/sf-dev`)
|
|
140
|
-
|
|
141
|
-
`/sf-dev` chama `/sf-merge-docs` automaticamente ao final de feature (não first-run):
|
|
142
|
-
|
|
143
|
-
- Condição: `status=dev_done` E `first_run=false` E (`prd_aprovado=true` OU `trd_aprovado=true`)
|
|
144
|
-
- Rodado inline, sem nova interação
|
|
145
|
-
- Falha em `/sf-merge-docs` não derruba `/sf-dev` — apenas reporta; user pode re-rodar manualmente
|
|
146
|
-
|
|
147
|
-
## Uso manual
|
|
148
|
-
|
|
149
|
-
Rodar `/sf-merge-docs $ARGUMENTS` quando:
|
|
150
|
-
- `/sf-dev` falhou e você quer sincronizar docs/ com o que já foi aprovado
|
|
151
|
-
- Fez edição direta em PRD/TRD aprovados e quer propagar pra docs/
|
|
152
|
-
- Quer forçar um re-merge (idempotente — não duplica)
|
|
1
|
+
|
|
2
|
+
# /sf-merge-docs $ARGUMENTS
|
|
3
|
+
|
|
4
|
+
Skill atômica pós-dev. Aplica as decisões de **PRD + TRD aprovados** em `docs/` pra manter a síntese cross-feature sincronizada com o estado do sistema.
|
|
5
|
+
`$ARGUMENTS` = nome do scope (ex: `feat_cadastro_cliente`).
|
|
6
|
+
|
|
7
|
+
Chamado automaticamente pelo `/sf-dev` ao final. Re-executável manualmente quando precisa.
|
|
8
|
+
|
|
9
|
+
> **Mudança v3 → v4**: antes aplicava `SDD §11 Delta Specs` (mecanismo OpenSpec).
|
|
10
|
+
> Agora lê **PRD + TRD aprovados diretamente** e infere o delta comparando com
|
|
11
|
+
> o estado atual de `docs/` (diff semântico). SDD não existe mais em v4.
|
|
12
|
+
|
|
13
|
+
## Agente: Integrator (Opus)
|
|
14
|
+
|
|
15
|
+
Em v4 promovido de Sonnet → Opus: diff semântico PRD/TRD ↔ docs/ exige reasoning
|
|
16
|
+
de maior nível que o antigo "aplicar §11 explícito". Meticuloso com consistência.
|
|
17
|
+
Merge idempotente — re-aplicar os mesmos docs source não duplica conteúdo.
|
|
18
|
+
|
|
19
|
+
## Pré-condições
|
|
20
|
+
|
|
21
|
+
| # | Validação | Se falhar |
|
|
22
|
+
|---|-----------|-----------|
|
|
23
|
+
| 1 | `$ARGUMENTS` informado | Parar |
|
|
24
|
+
| 2 | `.context.md` com status `dev_done` (uso auto no /sf-dev) OU `design_done` a mais (uso manual) | Se anterior → "Rode /sf-design primeiro" |
|
|
25
|
+
| 3 | Pelo menos PRD.md OU TRD.md existe e está aprovado | Parar — "Nenhum doc source aprovado pra mergear" |
|
|
26
|
+
| 4 | `docs/` populado (veio de first-run anterior) | Parar — "/sf-design com first_run=true é quem cria docs/" |
|
|
27
|
+
|
|
28
|
+
> `/sf-merge-docs` **só se aplica a features**, não a first-run. Em first-run, é o
|
|
29
|
+
> próprio `/sf-design` que cria `docs/` a partir de PRD+TRD — não há o que mergear.
|
|
30
|
+
|
|
31
|
+
## Passos
|
|
32
|
+
|
|
33
|
+
### 1. Snapshot do estado atual de docs/
|
|
34
|
+
|
|
35
|
+
Ler `docs/{architecture,domain,conventions,apiContracts,decisions}.md`.
|
|
36
|
+
Indexar por elementos (tabelas, endpoints, ADRs, papéis, env vars...) pra diff.
|
|
37
|
+
|
|
38
|
+
### 2. Extrair elementos-destino do PRD e TRD aprovados
|
|
39
|
+
|
|
40
|
+
| Fonte (PRD/TRD) | Elemento | Destino em docs/ |
|
|
41
|
+
|-----------------|----------|------------------|
|
|
42
|
+
| TRD §1.1 Stack | Nova tecnologia / versão | `architecture.md` §Stack |
|
|
43
|
+
| TRD §1.2 Arquitetura | Novo container / padrão | `architecture.md` §Containers/Padrões |
|
|
44
|
+
| TRD §1.3 Ambientes | Novo ambiente / mudança | `architecture.md` §Ambientes |
|
|
45
|
+
| TRD §1.4 Deploy | Mudança na estratégia | `architecture.md` §Deploy |
|
|
46
|
+
| TRD §4 §Área-DB | Nova tabela / índice / FK | `domain.md` §Catálogo de Tabelas |
|
|
47
|
+
| TRD §2.1 Endpoints | Novo endpoint | `apiContracts.md` §Catálogo |
|
|
48
|
+
| TRD §7.1 Auth | Mudança em auth | `conventions.md` §Autenticação |
|
|
49
|
+
| TRD §7.2 Autorização | Novo papel / permissão | `conventions.md` §Autorização |
|
|
50
|
+
| TRD §7.3 LGPD | Novo dado pessoal | `conventions.md` §LGPD |
|
|
51
|
+
| TRD §7.4 Rate limit | Nova categoria | `conventions.md` §Rate Limiting |
|
|
52
|
+
| TRD §5.3 Env vars | Nova variável | `conventions.md` §Variáveis de Ambiente |
|
|
53
|
+
| TRD §6 Integrações | Novo sistema externo | `domain.md` §Integrações Externas |
|
|
54
|
+
| TRD §9 ADRs | Nova decisão | `decisions.md` (append-only, imutável) |
|
|
55
|
+
| PRD §2 Atores | Novo papel/persona | `domain.md` §Usuários e Papéis |
|
|
56
|
+
| PRD §5 RNs | Nova regra de negócio | (não vai pra docs/ — fica em specs/{nome}/contracts.md) |
|
|
57
|
+
|
|
58
|
+
> **Regra**: PRD alimenta poucas seções de `docs/` (só atores e alto-nível).
|
|
59
|
+
> O grosso vem do TRD — `docs/` é síntese técnica + negócio cross-feature.
|
|
60
|
+
|
|
61
|
+
### 3. Diff semântico: calcular ADDED / MODIFIED / REMOVED
|
|
62
|
+
|
|
63
|
+
Pra cada elemento-destino extraído (passo 2), comparar com snapshot (passo 1):
|
|
64
|
+
|
|
65
|
+
| Resultado | Condição | Ação |
|
|
66
|
+
|-----------|----------|------|
|
|
67
|
+
| ADDED | Elemento não existe em docs/ | Adicionar na seção apropriada |
|
|
68
|
+
| MODIFIED | Elemento existe mas mudou (nome igual, valor diferente) | Atualizar campos |
|
|
69
|
+
| UNCHANGED | Elemento existe e está igual | Skip (idempotente) |
|
|
70
|
+
| REMOVED | Elemento estava em docs/ mas não aparece em PRD+TRD aprovados | **NÃO remover** — apenas registrar no output como "possivelmente orfão" |
|
|
71
|
+
|
|
72
|
+
> **Conservadorismo em REMOVED**: PRD/TRD falam só da feature atual. Algo que
|
|
73
|
+
> "não aparece" pode ser de outra feature (que continua válida). NUNCA deletar
|
|
74
|
+
> automaticamente. Reportar e deixar remoção manual.
|
|
75
|
+
|
|
76
|
+
### 4. Aplicar ADDED e MODIFIED
|
|
77
|
+
|
|
78
|
+
- Localizar seção apropriada no doc destino
|
|
79
|
+
- Preservar estrutura do template (não quebrar tabelas)
|
|
80
|
+
- ADRs em `decisions.md`: SEMPRE append; ADR com status=aceita é imutável
|
|
81
|
+
- Registrar cada mudança em changelog do doc afetado
|
|
82
|
+
|
|
83
|
+
### 5. Changelog em cada doc afetado
|
|
84
|
+
|
|
85
|
+
Adicionar linha no `## Changelog` do doc:
|
|
86
|
+
|
|
87
|
+
```markdown
|
|
88
|
+
| Data | Feature | Tipo | Descrição |
|
|
89
|
+
|------|---------|------|-----------|
|
|
90
|
+
| {{ISO_DATE}} | $ARGUMENTS | ADDED | Endpoint POST /api/v1/users |
|
|
91
|
+
| {{ISO_DATE}} | $ARGUMENTS | MODIFIED | Matriz de permissões: novo role `manager` |
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 6. Validar consistência cross-doc
|
|
95
|
+
|
|
96
|
+
- Referências quebradas (endpoint do apiContracts referencia tabela que não existe em domain) → reportar
|
|
97
|
+
- Papel novo em conventions mas não aparece em matriz de autorização → reportar
|
|
98
|
+
- ADR substituída mas ainda referenciada → reportar
|
|
99
|
+
|
|
100
|
+
Validação reporta, não bloqueia. Usuário decide se resolve manualmente.
|
|
101
|
+
|
|
102
|
+
### 7. Atualizar status
|
|
103
|
+
|
|
104
|
+
```yaml
|
|
105
|
+
status: "done"
|
|
106
|
+
ultima_skill: "/sf-merge-docs"
|
|
107
|
+
atualizado_em: "{{ISO_DATETIME}}"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### 8. Saída obrigatória
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
/sf-merge-docs $ARGUMENTS — completo
|
|
114
|
+
|
|
115
|
+
docs/ sincronizado com PRD + TRD aprovados:
|
|
116
|
+
- docs/architecture.md (2 ADDED, 0 MODIFIED)
|
|
117
|
+
- docs/apiContracts.md (3 ADDED, 1 MODIFIED)
|
|
118
|
+
- docs/conventions.md (0 ADDED, 1 MODIFIED — novo role)
|
|
119
|
+
- docs/decisions.md (1 ADDED — ADR-007)
|
|
120
|
+
- docs/domain.md (0 mudanças)
|
|
121
|
+
|
|
122
|
+
Possivelmente órfãos (NÃO removidos — revisão manual):
|
|
123
|
+
- docs/apiContracts.md: endpoint `/legacy/foo` não aparece em PRD+TRD novos
|
|
124
|
+
(pode ser de outra feature; deletar manualmente se confirmado deprecated)
|
|
125
|
+
|
|
126
|
+
Validação: passed / N issues
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Erros
|
|
130
|
+
|
|
131
|
+
| Erro | Ação |
|
|
132
|
+
|------|------|
|
|
133
|
+
| Status != `dev_done` (auto) nem >= `design_done` (manual) | Parar — pedir rodar /sf-dev ou /sf-design primeiro |
|
|
134
|
+
| `docs/` não existe | Parar — explicar que `/sf-design` em first-run cria docs/ (feature só atualiza) |
|
|
135
|
+
| PRD+TRD sem nada novo vs docs/ | Marcar `done` (legítimo — feature sem impacto cross-feature) |
|
|
136
|
+
| Elemento MODIFIED não encontrado no doc | Converter pra ADDED + reportar (doc estava desatualizado) |
|
|
137
|
+
| Referências quebradas detectadas | Reportar, não bloqueia |
|
|
138
|
+
|
|
139
|
+
## Uso automático (pelo `/sf-dev`)
|
|
140
|
+
|
|
141
|
+
`/sf-dev` chama `/sf-merge-docs` automaticamente ao final de feature (não first-run):
|
|
142
|
+
|
|
143
|
+
- Condição: `status=dev_done` E `first_run=false` E (`prd_aprovado=true` OU `trd_aprovado=true`)
|
|
144
|
+
- Rodado inline, sem nova interação
|
|
145
|
+
- Falha em `/sf-merge-docs` não derruba `/sf-dev` — apenas reporta; user pode re-rodar manualmente
|
|
146
|
+
|
|
147
|
+
## Uso manual
|
|
148
|
+
|
|
149
|
+
Rodar `/sf-merge-docs $ARGUMENTS` quando:
|
|
150
|
+
- `/sf-dev` falhou e você quer sincronizar docs/ com o que já foi aprovado
|
|
151
|
+
- Fez edição direta em PRD/TRD aprovados e quer propagar pra docs/
|
|
152
|
+
- Quer forçar um re-merge (idempotente — não duplica)
|