Verwenden des TODOCS-Platzhalters
Manchmal verwenden technische Redakteur*innen Platzhalter beim Schreiben von Dokumentationen, um sich daran zu erinnern, eine Aufgabe später noch zu erledigen. Dies ist eine nützliche Technik, aber es besteht immer die Möglichkeit, dass der Platzhalter übersehen wird und in die Produktionsumgebung übernommen wird. Zu diesem Zeitpunkt wird das Team für technische Inhalte nur herausfinden, ob jemand es sieht und meldet.
Um Fehler zu vermeiden, verwende die Zeichenfolge TODOCS als Platzhalter. Die Docs-Testsammlung enthält einen Lintingtest, der fehlschlägt, wenn diese Zeichenfolge an einer beliebigen Stelle in Markdown-Code oder einer YAML-Datei gefunden wird.
Hinweis
Wenn Sie VS Code als Texteditor verwenden, ist die Erweiterung TODO Highlight nützlich, um Vorkommen von „TODOCS“ in Ihren Dateien hervorzuheben. Füge den Einstellungen für diese Erweiterung „TODOCS“ und andere Elemente mit variierender Groß- und Kleinschreibung (z. B. „todocs“) hinzu.
Beispiel
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.