HANDBOOK

Um bom alinhamento habilita uma boa execução.

O Que

O handbook é um conjunto de padrões e práticas de desenvolvimento que uso em meus projetos pessoais. Estes padrões e práticas são baseados na minha experiência pessoal.

Por Que

O handbook é importante para desenvolver e entregar software com velocidade e qualidade. O handbook também é importante para alinhar humanos e agentes de IA, para um ambiente de desenvolvimento acelerado com IA produtivo e seguro (Harness).

Algumas vantagens:

• Ler é mais rápido do que ouvir.
• Ler é assíncrono, você não precisa interromper ou esperar as pessoas.
• Discutir mudanças é mais fácil se você pode ler como funciona atualmente.
• Comunicar mudanças é mais fácil se você pode mostrar as diferenças.
• Todas as pessoas podem colaborar sugerindo alterações através de uma PR.

Como

O handbook é estruturado como páginas organizadas em grupos, usando esta estrutura:

handbook/
  <nome-grupo>/
    titulo-pagina.md
    <nome-grupo>/
      titulo-pagina.md

Cada grupo é um diretório que pode conter páginas ou outros grupos.

Cada página é um arquivo Markdown, estruturado como:

# TÍTULO DA PÁGINA

## O Que

Descrição do assunto, em dois ou três parágrafos.

## Por Que

Importância do assunto, em dois ou três parágrafos.

## Como

Descrição do assunto, usando quantos parágrafos forem necessários. Podem ser organizados em seções específicas.

Este handbook foi inspirado no Handbook do GitLab.