Documentação

Contexto do projeto

Anexe os documentos, políticas e referências que o repositório por si só não consegue transmitir aos agentes.

Os agentes leem seu código. Contexto é onde você inclui o que o código não consegue expressar — as decisões, restrições e convenções que existem fora dele.

Para entender o motivo de algo pertencer aqui, leia Contexto do projeto em Conceitos. Esta página aborda como gerenciá-lo.

Adicionar contexto

Abra a seção Contexto do projeto e adicione uma entrada. Cada uma possui um título e corpo, podendo ser editada ou removida posteriormente.

Boas entradas são curtas, específicas e duráveis. Decisões de arquitetura, convenções de estilo, contratos API, limites de propriedade e proibições explícitas se encaixam aqui. A narrativa de integração e qualquer coisa já óbvia no repositório não devem ser incluídas.

Mantenha as entradas separadas e nomeadas

Uma entrada por tópico, com título indicando seu conteúdo. "Convenções de tratamento de erros" e "Módulos congelados" são fáceis de localizar; uma única entrada chamada "Notas" contendo ambos não é.

Isso é importante porque o contexto é carregado seletivamente conforme o trabalho em questão — veja Habilidades progressivas. Entradas bem separadas permitem que a adequada seja carregada para cada tarefa.

Referências

Além das entradas escritas, você pode anexar referências — links e documentos que apontam para materiais armazenados em outro lugar. Use-as quando a versão oficial estiver em uma wiki ou ferramenta de design e você não quiser manter uma cópia desatualizada.

Contexto por tarefa

O contexto do projeto se aplica a tudo nele. Para material relevante a uma única tarefa — um chamado, um relatório de cliente, um documento de design — anexe-o àquela tarefa. Uma nota específica de tarefa deixada no contexto do projeto vira ruído em cada tarefa futura.

Mantendo-o atualizado

Contexto desatualizado é pior que contexto ausente, pois os agentes o consideram autoritativo. Quando uma convenção mudar, atualize a entrada na mesma alteração que modifica o código.

Revisando o que existe

Leia seu contexto ocasionalmente como se fosse um novo usuário. As entradas se acumulam, e aquelas criadas durante uma migração concluída há um ano agora podem induzir a erros.