ワークアイテムフレームワークにおける協業

背景

ワークアイテムとは、より大きなプロジェクトやワークフローの一部として完了すべき個別のタスクまたは作業単位です。目標達成や望ましい成果の実現に寄与する個別の作業要素を表します。ワークアイテムは、アジャイルプランニング、ITSM、セキュリティ管理など、多くのユースケースの一部となっています。 以前は、GitLab にはワークアイテムに対する異なる実装がありました。例として Epic、Issue、Requirement、Incident、Vulnerability があります。このアプローチは、一貫性のない体験のためにユーザーからの不満を招き、Plan ステージは GitLab のすべてのワークアイテムをサポートするフレームワークを構築することを決定しました。このガイドでは、利用可能な機能、その使い方、フレームワークに貢献するための最適なアプローチを説明します。

なぜワークアイテムフレームワークを使うのか?

ワークアイテムフレームワークは、チームが GitLab で作業を計画・整理するためのワークアイテムオブジェクトを作成するための一貫したアプローチを提供します。フレームワークの利用者は、容易に拡張可能で、包括的な標準機能を備えたフレームワークを使う効率性の恩恵を受けられます。

どのような機能が利用可能か?

ワークアイテムフレームワークは 基本のワークアイテムオブジェクト を提供し、ウィジェット を使って機能を拡張するオプションがあります。追加のワークアイテムデータと機能はウィジェット内にカプセル化されています。例えば、WorkItemWidgetAssignees は、ユーザー割り当てを可能にします。

利用可能なウィジェットの一覧は こちら で確認できます。コアのワークアイテムオブジェクトを除き、各ウィジェットはワークアイテムタイプごとにオン/オフを切り替えできます。

ワークアイテムフレームワークは、標準のワークアイテム詳細ビューも提供しており、必要に応じてワークアイテムを Issue 一覧に表示することもできます。

ワークアイテムフレームワークはどこで使われているか?

ワークアイテムフレームワークは現在、Tasks や OKRs を含むいくつかの機能で使用されています。

Issues や Epics のように、既存のオブジェクトをワークアイテムタイプに変換し、新しいものを実装する作業が進行中です。

現在実装されている、または実装中のワークアイテムタイプの包括的なリストは、アーキテクチャブループリント で確認できます。

ワークアイテムフレームワークのロードマップにある機能は何か?

Plan ステージ方向性ページ と私たちの GitLab Issue トラッカー で、計画されている新機能を確認できます。

ワークアイテムフレームワークのスコープ外は何か?

• 私たちの目標は GitLab における一貫性を高めることであり、すべてのワークアイテムは同じワークアイテム詳細ビューを使用すべきです。
• 別々のビューや拡張を構築するのではなく、チームが直接フレームワークに貢献することを推奨します。

はじめ方

まず、ワークアイテムフレームワークが自分の機能にとって適切かを検討する必要があります。ユーザーと、ユーザーが必要とする体験を含めて検討します。そのプロセスについては こちら を参照してください。

すべてのコントリビューションは、Validation backlog および Problem validation フェーズから始まります。これらのフェーズでは、Plan ステージの PM は今後の検証活動について Informed であるべきで、Problem validation 中は Consulted であるべきです。これらは、私たちと協業し、あなたの要望が将来のロードマップ項目と重複していないこと、そして指針となる原則に反していないことを確認するための重要な機会です。

R、A、C、I の意味は何ですか?

このフェーズの終わりに、私たちはあなたのグループと協力してコントリビューションモデルを決定します。

コントリビューションモデル

ワークアイテムフレームワークを使用することを決めた場合、通常はこれは新しいワークアイテムタイプを作成すること、そして/または新しいウィジェットを作成することを意味します。場合によっては、必要なすべての機能がすでにフレームワークに存在することもあります。やった! そうでない場合は、あなたのユースケースのためにフレームワークを拡張する ことができます。

新しいワークアイテムタイプの作成

あなたのグループがユーザーの作業を表す特定のワークアイテムタイプを必要とする場合、新しいワークアイテムタイプを作成できます。新しいワークアイテムタイプの作成は、あなたのユースケースに固有のデータとビヘイビアのためのウィジェットを追加する基礎を築きます。例えば、OKR には他のワークアイテムタイプには存在しない 進捗ウィジェット があります。

ソリューション検証と構築計画プロセスの例は、この Epic で確認できます。ここでは PM が Objective と Key Result ワークアイテムタイプで望ましいデータ要素とビヘイビアを定義しました。

技術的な実装プロセスの詳細については、ドキュメント を参照してください。OKR の導入における実装例を以下で確認できます:

• Objective および Key Result ワークアイテムタイプを追加するバックエンドの作業
• 機能フラグの後ろで Objective の作成をサポートするためのバックエンド作業
• Objective の作成をサポートし、Issue 一覧に含めるためのフロントエンド作業

Work Items フレームワークへの貢献

Work Items フレームワークは GitLab における計画と協業の中核にあり、他のチームからの貢献を歓迎しています。新しいウィジェットやデータ要素をうまく統合できるよう、このページでは主な検討事項をまとめています。貢献のスコープに応じてすべての項目に対応する必要はないかもしれませんが、すべてを確認することで、あなたの機能が堅牢で、ユーザーフレンドリーで、GitLab の他の部分と一貫したものになることを確保します。 ヒント: GitLab のワークアイテムアーキテクチャビジョンと エンジニアリングのベストプラクティス に従って、アーキテクチャの整合性を確保しましょう。

一般的な検討事項

ヒント: 特定の項目が自分のコントリビューションに該当するか不明な場合、またはデザインについて明確化が必要な場合は、Plan UX チーム と Work Items の PM に相談してください。私たちはここにいて、GitLab ユーザーを喜ばせ、Work Items フレームワークにシームレスに適合する機能の出荷を支援します。

ウィジェットの作成または変更

ウィジェットは、ワークアイテムを互いに区別する固有のデータとビヘイビアを包含します。ワークアイテムウィジェットを変更したり新規追加したりする必要がある場合は、技術的な詳細について このページ を参照してください。 日付ウィジェットの導入 における実装例を確認できます。なお、このウィジェットは複数のワークアイテムタイプで使用される予定です。

アイデアのみ

時には、あなたのチームにフレームワークに貢献するキャパシティや専門知識がないこともあります。それで構いません! それでも私たちはあなたの声を聞きたいと考えています。ニーズを記述した Issue を作成し、@gweaver と @amandarueda をタグ付けしてください。

ページのソースコードを見る - ページの編集 - please contribute.