Pular para o conteúdo

doc-rfc

/octopus:doc-rfc é o primeiro passo quando uma mudança é grande o suficiente pra precisar de alinhamento antes de qualquer spec ser escrito. Ele cria um documento RFC datado a partir do template do Octopus, então a conversa acontece por escrito — com todo mundo lendo o mesmo enquadramento.

O que resolve

Features que pulam o passo de consenso costumam gerar desacordos caros no meio da implementação. Um RFC força que o problema, a proposta e as alternativas sejam colocados em texto antes de o trabalho de design começar — transformando uma futura reunião ou thread de chat num documento revisável.

O RFC também funciona como âncora upstream pra o restante do pipeline. Uma vez aprovado, o /octopus:doc-spec pode fazer referência a ele, então os leitores sempre sabem por que a feature foi desenhada daquela forma.

Como funciona

  1. Resolve o slug — a partir do argumento que você passa, ou perguntando.
  2. Determina a data de hoje e monta o caminho de destino: docs/rfcs/<data>-<slug>.md.
  3. Lê o template de RFC e preenche a data e o título.
  4. Escreve o arquivo e informa o caminho.
  5. Lembra você de preencher as seções e compartilhar com stakeholders, e sugere criar um spec com /octopus:doc-spec depois que o RFC for aprovado.

Este é um comando de bootstrapping — ele cria a estrutura do documento; o conteúdo é seu pra escrever.

Posição no pipeline

doc-rfcdoc-specdoc-designdoc-plan

RFCs ficam upstream de tudo. Quando o consenso já está estabelecido (brainstorm síncrono, direção óbvia), pule o RFC e vá direto pra /octopus:doc-spec.

Uso & parâmetros

/octopus:doc-rfc [slug]
  • [slug] — nome em kebab-case pro RFC (ex: politica-retry-pagamento). Se omitido, o comando pede antes de continuar.

Source: commands/doc-rfc.md