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.