Skip to main content

TODOCS プレースホルダーを使ってメモを残す

TODOCS プレースホルダーを使い、依然として完了する必要がある作業を示すことができます。

TODOCS プレースホルダーを使う

テクニカル ライターは文書の作成中、後で見直すため、プレースホルダーを使うことがあります。 便利なやり方ではありますが、プレースホルダーが見落とされ、運用環境に入り込む可能性があります。 そのなると、文書チームとしては、誰かが見つけて報告する以外、見落としを見つける方法がありません。

見落としを防ぐには、プレースホルダーに文字列 TODOCS を使います。 文書テスト スイートには、リンティング テストが含まれています。Markdown または YAML のどこかにこの文字列があると、このテストは不合格になります。

Note

テキスト エディターとして 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.