ドキュメンテーションのワークフロー

GitLabのドキュメントはワークフローに沿っています。

マージする前に

文書に以下の内容が含まれていることを確認してください：

スタイルガイドと 単語リストに従っていることを確認します。

文書ラベル

イシューやマージリクエストの作成者は、ドキュメントテンプレートを選択してください。このテンプレートにはこれらのラベルが含まれ、マージリクエストに追加されます：

テクニカルライティングチームのメンバーがこれらのラベルを追加します：

マージ後のレビュー

マージ前にテクニカルライターによるレビューが割り当てられていない場合、開発者またはメンテナーはマージ直後にレビューを行う必要があります。そのためには、ドキュメントレビュー記述テンプレートを使ってイシューを作成し、ドキュメント変更を導入したマージリクエストからリンクしてください。

通常のマージ前のテクニカルライターによるレビューが省略される状況には、次のようなものがあります：

  • マイルストーンリリースまでの期間が短い場合。残り日数が3日未満の場合は、マージ後のレビューを依頼し、Slack経由でライターにpingを送り、できるだけ早くレビューが完了するようにしてください。
  • 変更の規模が小さく、その機能の初期のユーザー（例えばGitLab.comのユーザー）が書かれているとおりにドキュメントを簡単に使えるという高い確信があります。

覚えておきましょう：

  • GitLabでは、ドキュメントをコードのように扱います。コードと同じように、ドキュメントも品質を保証するためにレビューされなければなりません。
  • ドキュメンテーションはGitLabの定義の一部を形成しています。
  • マージ前のテクニカルライターによるレビューは、マイルストーンリリースのかなり前にコードが完成しているときや、より大きなドキュメントの変更に対して行われるのが一般的です。
  • ドキュメントのマージ後のテクニカルライターレビューをリクエストできるのは、 そのドキュメントのコードをできるだけ早くマージすることが重要な場合です。この場合、最初の MR の作成者は、テクニカルライターから提供されたフィードバックをフォローアップ MR でアドレスすることができます。
  • また、テクニカルライターは、テクニカルライターのレビューなしでドキュメントをマージし、マージ後すぐにレビューを行うこともできます。

ChatGPTやAIが作成したコンテンツをドキュメントに使用しないでください。

GitLabドキュメントはCC BY-SA 4.0ライセンスでディストリビューションされており、GitLabがドキュメントを所有していることを前提としています。

米国とEUの現在の法律では、AIが生成した著作物はどちらかになる可能性があります：

  • 人間によって創作されたものではないため、誰の所有物にもならないか、あるいは
  • AIが学習したコンテンツをそのまま再現した場合、AIの学習データの作成者に帰属します。

ドキュメントにAIが作成したコンテンツが含まれている場合、GitLabはおそらくこのコンテンツを所有していないでしょう。

GitLabドキュメントへの貢献は、DCOまたはCLA条項のどちらかの下で行われます。どちらの場合でも、寄稿者は、AIによって生成されたテキストに対しては有効にはできない、作品の著作者であることを証明しなければなりません。

これらの理由から、AIが生成したコンテンツをドキュメントに追加しないでください。