← Voltar ao catálogo
LoopEngenharia↓ 0

Loop de Varredura de Documentação

Mantém a documentação alinhada ao código atual e abre um pull request revisável a cada passada.

Loops são rotinas de uso — não se instalam por comando. Veja como acioná-lo logo abaixo.

Este loop mantém a documentação em sincronia com o código à medida que ele muda.

O ciclo compara docs e fonte, encontra qualquer API pública, flag de CLI ou opção de config que mudou ou está sem documentar, atualiza o menor pedaço possível e abre um PR focado.

Ele repete até docs e código concordarem totalmente.

Em vez de um lote gigante, cada melhoria vira um PR pequeno e revisável, com o build de docs sem avisos.

Quando usar

  • Após releases que renomeiam flags, APIs ou configs.
  • Quando a documentação vive atrasada em relação ao código.
  • Para gerar PRs de docs pequenos e fáceis de revisar.

Como usar

Rode o loop pedindo para comparar docs e código, atualizar o que divergiu e abrir um PR focado, continuando até docs e código baterem.