実験とベータ機能の文書化

いくつかの機能は一般に利用可能ではなく、代わりに実験またはベータとみなされています。

これら3つのステータスのいずれかに該当する機能をドキュメント化する場合:

  • ページまたはトピックのタイトルの後に階層バッジを追加します。
  • (Experiment)(Beta) を左ナビに含めないでください。
  • バージョン履歴に機能のステータスが表示されるようにしてください。

これらの機能は通常、機能フラグの後ろにあり、これらのドキュメントガイドラインに従っています。

ユーザーがどのように登録すべきか、あるいはイシューが発生した場合のチームへの連絡方法などの詳細を追加する場合は、FLAG:

使用例:

## Great new feature **(EXPERIMENT)**

> [Introduced](link) in GitLab 15.10. This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md).

FLAG:
On self-managed GitLab, by default this feature is not available.
To make it available, an administrator can enable the feature flag named `example_flag`.
On GitLab.com, this feature is not available. This feature is not ready for production use.

Use this great new feature when you need to do this new thing.

This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md). To join
the list of users testing this feature, do this thing. If you find a bug,
[open an issue](link).

その機能が本番稼動できるようになったら、削除してください:

  • 括弧内のテキスト。
  • 本文の説明で、その機能がまだ生産準備中でないことを示す文言。
  • もしあれば、機能フラグ情報。

製品リリースに関するメモを追加することで、バージョン履歴が最新であることを確認します。