Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2.5 KiB
LEIA PRIMEIRO
Documentação única e oficial da stack (Clube67 / ScoreOdonto e demais projetos). Repositório (fonte da verdade):
git.clube67.com/ruicesar/Documentos-Unicos. Leia este arquivo antes de qualquer outra coisa.
Regras obrigatórias
-
Idioma: PORTUGUÊS. Tudo — explicações, documentos, comentários, commits, conversas — em português. Sem exceção.
-
Fonte única. Este repositório é a documentação oficial e vigente. Qualquer
.mdfora daqui que divergir não vale. -
Uma situação = um arquivo. Organização em pastas por tipo; dentro, um
.mdpor situação. Nunca misturar situações num mesmo arquivo. Situação nova = arquivo novo (ou pasta nova de tipo). -
Atualizar = REESCREVER o arquivo da situação (nunca "v2" ao lado). O arquivo descreve o estado ATUAL real, nunca o desejado.
-
Versão antiga →
desuso/. Antes de reescrever, copie a versão anterior paradesuso/com data no nome e aviso EM DESUSO no topo. -
Cada projeto só tem um
LEIA.mdna raiz, que aponta para este repositório — nunca guarda documentação própria espalhada. -
desuso/é só CONSULTA. Em dúvida, consulte odesuso/para entender o histórico / tirar dúvida ou como base para corrigir/melhorar. Mas ele nunca é instrução vigente: toda instrução nova ou atualizada vai na doc oficial (fora dodesuso/). -
Sempre testar em
https://dev.<projeto>antes de qualquer coisa. -
Sempre pedir aprovação do administrador antes de ir para produção ou implementar novas melhorias/implementações.
-
Antes de anotar, checar duplicação. Verifique se o tema já existe aqui — não duplicar. Prefira sempre doc UNIVERSAL (serve a todos os projetos). Se um projeto for diferente: cite o que o torna diferente e crie a doc específica dele em
projetos/<projeto>/— para a doc universal ficar sempre alinhada (não poluída com exceções).
Organização deste repositório
| Pasta | Conteúdo |
|---|---|
deploy/ |
Deploy (universal): modelo, subir-release, rollback, versionamento. |
infra/ |
Infraestrutura (universal): maquinas-e-rede, ambiente-dev. |
projetos/<projeto>/ |
Só o que DIFERE do universal, por projeto (cita o delta + referencia o universal). |
desuso/ |
Histórico/obsoletos (datado, "EM DESUSO"). Só consulta. |
Tipo de assunto novo (ex.: segurança, banco, monitoramento)? Crie uma pasta nova aqui com os
.mddas situações.