TODOCS プレースホルダーを使う
テクニカル ライターは文書の作成中、後で見直すため、プレースホルダーを使うことがあります。 便利な手法ではありますが、いつもプレースホルダーが見落とされ、運用環境に入り込むリスクがあります。 その時点では、文書チームがそれを知る方法は、誰かが見つけて報告すること以外にありません。
見落としを防ぐには、プレースホルダーに文字列 TODOCS を使います。 文書テスト スイートには、リンティング テストが含まれています。Markdown または YAML のどこかにこの文字列があると、このテストは不合格になります。
メモ
テキスト エディターとして VS Code をお使いの場合は、TODO Highlight 拡張機能を使ってファイル内の "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.