engineering-playbook 1.0.0

AI Assisted Engineering Framework

Ricardo Engineering Playbook

Este repositório define os princípios, padrões, templates e checklists usados nos projetos técnicos de Ricardo Calixto.

Ele serve como referência para engenharia de software, arquitetura, documentação, revisão de código, segurança, testes, DevOps e uso de IA em projetos.

Estrutura

• 01-principles/ — princípios gerais de engenharia
• 02-architecture/ — padrões arquiteturais e tomada de decisão
• 03-code-review/ — critérios de revisão de código
• 04-documentation/ — padrões de documentação técnica
• 05-security/ — segurança por padrão
• 06-testing/ — testes e validação
• 07-devops/ — operação, deploy e automação
• 08-ai/ — como a IA deve atuar nos projetos
• 09-templates/ — templates reutilizáveis
• 10-checklists/ — checklists operacionais

---

Contrato de Colocação

Este playbook contém apenas padrões reutilizáveis de engenharia.

Um conteúdo deve entrar no Engineering Playbook somente se atender aos dois critérios:

1. Seria aplicável de forma idêntica ou quase idêntica em pelo menos 3 projetos.
2. Mudaria por uma razão organizacional ou de padrão técnico, e não por uma necessidade específica de um projeto.

Caso contrário, o conteúdo deve permanecer no projeto correspondente.

Vai para o Playbook

• princípios de arquitetura;
• padrões de documentação;
• critérios de revisão de código;
• checklists;
• templates;
• regras gerais de segurança;
• boas práticas de testes;
• padrões de uso de IA.

Fica no Projeto

• stack específica;
• comandos do projeto;
• regras de negócio;
• usuários, perfis e permissões;
• decisões arquiteturais do projeto;
• fluxos específicos;
• bugs conhecidos;
• histórico de correções;
• runbooks operacionais do sistema.