Pular para conteúdo

Using the SOT

1. Objetivo

Este documento ensina como usar o SOT no dia a dia.

Ele serve tanto para onboarding humano quanto para orientar o uso combinado com agentes.

2. Papel de cada area do repositorio

Area Funcao principal
docs/ documentacao para humanos e navegacao renderizada
method/ processo de trabalho, SDLC e uso do SOT
product-definition/ problema, inception e handoff
plan/ backlog, sprints, ADRs, rastreabilidade e acompanhamento
agents/ guardrails, contexto e skills operacionais para agentes

3. Regra simples de uso

Quando surgir uma duvida, pergunte:

  • estamos entendendo o problema? -> product-definition/discovery/
  • estamos propondo o recorte da solucao? -> product-definition/inception/
  • estamos definindo como executar? -> plan/ e plan/adr/
  • estamos ensinando pessoas ou agentes a trabalhar? -> method/ e agents/

4. Relacao entre humanos e agentes

4.1 Documentacao para humanos

docs/ e o site renderizado existem para:

  • onboarding
  • leitura transversal
  • navegacao clara
  • tomada de decisao coletiva

4.2 Documentacao para agentes

agents/ existe para:

  • contexto especifico por funcao
  • guardrails
  • definicao de escopo operacional
  • reutilizacao de instrucoes

4.3 Regra de consistencia

O que um agente faz deve ser coerente com o que a documentacao humana declara.

Se houver conflito:

  • o SOT precisa ser corrigido
  • ou o agent precisa ser ajustado

5. Fluxo de uso por fase

5.1 SOW

Usar principalmente:

  • method/
  • referencias iniciais em product-definition/
  • CONTRIBUTING.md para governanca

5.2 Discovery

Usar principalmente:

  • product-definition/discovery/
  • product-definition/templates/
  • method/phase-playbook.md

5.3 Inception

Usar principalmente:

  • product-definition/inception/
  • plan/project_definitions.md
  • plan/adr/

5.4 Implementation

Usar principalmente:

  • plan/dev/
  • plan/ops/
  • method/task-execution-and-project-flow.md
  • agents/dev/
  • agents/ops/

6. O que registrar em cada lugar

Tipo de conteudo Lugar principal
problema, dor, contexto product-definition/discovery/
proposta de recorte e macro-solucao product-definition/inception/
direcao arquitetural relevante plan/adr/
backlog e sprints plan/dev/ e plan/ops/
regras de uso de agentes agents/
metodo e onboarding method/
execucao de tasks e fluxo do board method/task-execution-and-project-flow.md

7. Anti-padroes a evitar

  • usar plan/ para registrar discovery
  • usar agents/ como se fosse documentacao de negocio
  • colocar decisoes arquiteturais relevantes apenas em conversa, issue ou PR
  • colocar detalhes de implementacao no discovery como se fossem dominio do problema
  • deixar backlog sem rastreabilidade para inception ou ADR

8. Regra de navegacao

A documentacao renderizada no MkDocs deve ser tratada como forma principal de leitura.

O markdown bruto continua sendo a fonte versionada, mas a navegacao renderizada ajuda a:

  • validar coesao
  • reduzir perda de contexto
  • acelerar onboarding

Quando houver publicacao web do SOT, a preferencia e expor essa leitura por um endpoint protegido, em vez de manter a consulta apenas local.

Referencia operacional:

  • method/publishing-and-access.md

9. Regra de adocao rapida

Para um novo colaborador, a sequencia minima de onboarding no SOT deve ser:

  1. method/README.md
  2. method/sdlc-operating-model.md
  3. method/using-the-sot.md
  4. product-definition/README.md
  5. artefatos do dominio em que vai atuar