Uso del marcador de posición TODOCS
A veces, los escritores técnicos usan marcadores de posición mientras escriben documentación para recordarse a sí mismos que recuperen algo más tarde. Es una técnica útil, pero siempre existe la posibilidad de que el marcador de posición se pase por alto y entre en producción. En ese momento, la única forma de enterarse con la que cuenta el equipo de Docs es si alguien lo ve y lo notifica.
Para evitar errores, usa la cadena TODOCS
como marcador de posición. En el conjunto de pruebas de Docs se incluye una prueba de linting que devolverá un error si encuentra esta cadena en cualquier parte de un archivo Markdown o YAML.
Note
Si usas VS Code como editor de texto, la extensión TODO Highlight es útil para resaltar instancias de "TODOCS" en los archivos. Agrega "TODOCS" y otras variedades de mayúsculas y minúsculas, como "todocs", a la configuración de esta extensión.
Ejemplo
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.