Использование заполнителя TODOCS
Иногда технические писатели используют заполнители при написании документации, чтобы напомнить себе, чтобы вернуться к чему-то позже. Это полезный способ, но всегда есть вероятность того, что заполнитель будет пропущен и проскользнуть в рабочую среду. На этом этапе единственный способ, по которому команда "Документация" узнает об этом, если кто-то видит его и сообщает об этом.
Чтобы предотвратить скольжения, используйте строку TODOCS в качестве заполнителя. Набор тестов Docs включает тест на подкладку, который завершится ошибкой, если он находит эту строку в любом месте файла Markdown или YAML.
Note
Если в качестве текстового редактора используется VS Code, расширение выделения TODO полезно для выделения экземпляров TODOCS в файлах. Добавьте toDOCS и другие разновидности регистра, например todocs, в параметры этого расширения.
Пример
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.