Pular para o conteúdo principal

Regras de estilo da documentação

Para manter a documentação do Klar confiável:

1) Separe “hoje” de “planejado”​

Sempre marque:

  • hoje (implementado)
  • planejado (não implementado)
  • ND/NI de forma clara

2) Todo guia deve ser executável​

Se um guia incluir comandos, eles devem funcionar com:

  • uma instalação limpa via Loom
  • um único arquivo .kl

3) Evite linguagem vaga​

Ruim:

  • “provavelmente deveria”
  • “talvez funcione”
  • “pode ser que”

Bom:

  • “implementado”
  • “não implementado”
  • “instável”
  • “planejado”

4) Prefira exemplos a parágrafos​

O Klar é rigoroso. Exemplos reduzem interpretações incorretas.