Pular para o conteúdo

Padrões

Padrões e manutenção das docs

Mantenha identidade, comportamento, evidência e planejamento em seus lugares.

Documente comportamento verificável

A hierarquia PLAT → SYS → MOD → FEAT organiza o produto. Cada página identifica finalidade, estado, origem e vínculos. Uma feature descreve pré-condições, fluxo, alternativas, pós-condições, regras e critérios de aceite. Dados, APIs e operação precisam de limites explícitos. No Orkastery, o número de uma FEAT nova sai de ork roadmap feat, reservado entre máquinas; nunca do maior número da sua branch.

ork roadmap feat --thread <thread>
ork docs verificar
ork docs sincronizar

Separe plano de disponibilidade

O roadmap registra problema, objetivo, escopo, dependências, decisões e critérios de validação. Código mesclado, testes aprovados, deploy e exposição ao usuário são fatos diferentes. Nos sites, o roadmap aparece somente como resumo mensal com link para a fonte.

No Orkastery, ork docs sincronizar atualiza o estado do código a partir do ledger e do git, e a seção sdlc a partir da thread; nunca mexe em ciclo, documentação, deploy, exposição ou habilitação. Na worktree de uma thread, só toca o item dela; --so escolhe os itens e --todos volta a todos. Fechar a thread solta a reserva do item ou a passa para outra thread aberta do mesmo item.

Revisão editorial e visual

Use caixa de frase nos títulos e rótulos; preserve siglas, comandos e nomes próprios. Diagramas têm título, descrição e sequência legível sem depender da cor. Os índices e modelos orientam a edição; os ativos de marca permanecem na origem e não representam funcionalidades adicionais.

O snapshot público registra caminhos relativos e hashes. Sincronizar uma fonte alterada invalida as revisões afetadas. A revisão das três línguas é explícita e o build funciona com o snapshot versionado, sem buscar conteúdo remoto.

Contrato não é resultado medido

Os contratos KG1 fixam grafo e benchmark separadamente. O grafo conserva proveniência e restrições de acesso e recalcula identidades pelo conteúdo. O benchmark fixa pares A/B, tarefas, controles, tentativas e fontes de medida. Corpus sintético valida o contrato; não demonstra economia de tokens, latência ou significância. Uma medida ausente fica null com motivo. A extração do KG2 e o índice com consulta do KG3 vieram sem mudar o contrato. A primeira medida de custo de consulta do KG3 registra bytes e latência dos dois braços, sem tokens medidos; não é a linha de base do benchmark e não conclui economia. O consumo pelas fases continua fora.