O agente escreve a documentação.Você mantém-na certa.

Uma pasta de documentação, formatada

Arraste a pasta da documentação para o DotMD e ela passa a ser o seu espaço de trabalho. As páginas abrem em separadores e a barra lateral lista-as por título, não por nome de ficheiro. O título vem do campo title: do front matter da página ou, na falta dele, do primeiro título. As propriedades aparecem como um cartão acima da página.

⇧⌘F procura nos nomes dos ficheiros e em cada linha de texto de todas as pastas do espaço de trabalho, por isso encontrar a página que menciona uma definição demora um segundo.

Reveja os rascunhos do agente

1. Peça a página como ficheiro

   «Escreve o guia de instalação em docs/install.md e envia-mo no DotMD para revisão.»

2. Comente cada problema

   Selecione a frase com o comando errado ou o passo pouco claro, prima ⌥⌘M e diga como deve ser. Percorra primeiro a página toda.

3. Envie e verifique as correções

   Clique em Send. O agente corrige cada comentário e cada correção aparece no ficheiro, o texto antigo a vermelho e o novo a verde, junto ao seu comentário. Accept ou Reopen.

4. Aprovar

   Quando já não houver nada a mudar, clique em Approve.

Os comentários são guardados pelo DotMD, não no ficheiro, por isso o seu Markdown não tem marcas nem comentários HTML. Acompanham a página se a renomear ou mover.

Cada versão, restaurável

O DotMD guarda versões anteriores de cada ficheiro que abre. Abra o histórico e cada versão aparece formatada, com o que mudou desde a anterior: texto acrescentado a verde, texto removido a vermelho.

• Revert de um único bloco alterado, como um parágrafo ou uma linha de tabela, mantendo o resto.
• Restore de uma versão anterior inteira. O texto atual é guardado primeiro como versão, por isso um restore pode ser desfeito.
• Os ficheiros que outra app alterou, por exemplo um agente ou o git, recebem um ponto laranja na barra lateral. Abra um e o DotMD vai direto ao que mudou desde a última vez que o leu.

Um ficheiro criado por um agente mantém uma só versão até o abrir pela primeira vez, por isso as alterações contam a partir do texto que leu primeiro.

Quando o ficheiro aberto muda no disco, uma faixa mostra quantas linhas foram acrescentadas e removidas, e Show Changes abre o histórico comparando-o com o texto anterior.

Deixe um segundo agente verificar os factos

Uma página pode ler-se bem e estar errada. Peça a outro agente que a verifique e as observações chegam ao DotMD como comentários com o seu nome, para manter ou eliminar antes de o autor as ver:

«Revê docs/install.md no DotMD e deixa comentários em cada comando que não funciona.»

É o ciclo descrito em Um agente revê outro. Você modera os comentários, por isso o autor só recebe as observações com que concorda.

Veja o que os leitores vão ver

O DotMD desenha diagramas Mermaid, fórmulas KaTeX, tabelas, callouts e código com realce, por isso lê a página como os seus leitores a vão ler. Para a passar, exporte para PDF ou HTML, copie-a como texto formatado para o Mail, as Notas, o Pages ou o Google Docs, copie o seu código HTML para um blogue ou CMS, ou imprima-a.

Perguntas de redatores técnicos

Mais perguntas