Skip to main content

Como usar o espaço reservado TODOCS para deixar observações

Use o espaço reservado TODOCS para indicar o trabalho que ainda precisa ser concluído.

Como usar o espaço reservado TODOCS

Às vezes, os redatores técnicos usam espaços reservados enquanto escrevem a documentação para se lembrarem de voltar a algo mais tarde. Essa é uma técnica útil, mas há sempre a possibilidade de que o espaço reservado seja ignorado e passe despercebido para a produção. Nesse ponto, a única maneira de a equipe do Docs descobrir isso é se alguém vê-lo e relatá-lo.

A fim de evitar deslizes, use a cadeia de caracteres TODOCS como espaço reservado. O conjunto de testes do Docs inclui um teste de lint que falhará se encontrar essa cadeia de caracteres em qualquer lugar em um arquivo Markdown ou YAML.

Note

Se você usar o VS Code como editor de texto, a extensão "Realce de TODO" será útil para realçar as instâncias de "TODOCS" nos arquivos. Adicione "TODOCS" e outras variedades de uso de maiúsculas e minúsculas, como "todocs", às configurações dessa extensão.

Exemplo

1. In the dropdown, select the settings you want to sync.

   TODOCS: ADD A SCREENSHOT OF THE SETTINGS SYNC OPTIONS

1. Click **Sign in & Turn on**, then select the account to which you want your settings to be synced.