コンテンツのワークフローについて理解する
ドキュメントを作成する過程で、コンテンツはいくつかのステータスを経ます。各ステータスでは、それぞれに異なるロールを持つユーザーからの入力が必要です。
各ステータスは、ドキュメント作成のプロセスでの対応するステージを表します。すべてのオブジェクトにはステータスが与えられ、オブジェクトがどのステージにあるかを示します。オブジェクトは、デプロイメントで定義されたワークフローに従ってステータスが変化します。たとえば、トピックは次のワークフローでContributeステータスからDoneステータスに変化する場合があります。
オブジェクトのステータスから以下を理解することができます。
- ドキュメンテーション プロセスのどの段階なのか
- 次にどんな作業が必要か
- 完了前に何を達成する必要があるか
ロールとワークフロー
各ユーザーには 1 つ以上のロールがあります。たとえば、デプロイメントには、コントリビュータ、ライター、レビューアなどのロールが含まれる場合があります。ロールを使用してユーザーがコンテンツに割り当てられた場合、そのユーザーは割り当てられたコンテンツに対して、そのロールに固有の方法で作業することが期待されます。
たとえば、対象分野の専門家 (SME) がコンテンツを作成し、それをテクニカル ライターに提供して改良することが期待される場合があります。この場合、対象分野の専門家は、コントリビューターのロールで割り当てられている間に新しいコンテンツを作成することができます。そして、テクニカル ライターはライターのロールを持つことができます。完了すると、テクニカル ライターはコンテンツを専門家に戻し、専門家にレビューアのロールを割り当てて検証および変更を依頼します。
各ロールは特定のステータスのオブジェクトに対してのみ作業を行います。それぞれに異なるロールがオブジェクトの作業を行う必要があるため、ライターまたは他のユーザーがオブジェクトのステータスを変更することができます。これにより、適切なロールを持つユーザーがオブジェクトに対して作業を行うことができるよになります。
オブジェクトの依存関係とワークフロー
オブジェクトは、そのワークフローにおいて、参照しているオブジェクトの依存関係よりも先のステータスに進むことができません。たとえば、あるトピックが複数の画像を参照している場合、参照している画像がDoneステータスに移動しないと、そのトピックはDoneステータスに移動することはできません。これにより、オブジェクトは、少なくとも自分と同程度に完成している依存関係のみを参照することを保証します。たとえば、まだWorkステータスで未完成の状態の conref を参照しているトピックがDoneステータスになることを防ぎます。さもないと、未完成のコンテンツが、完了しているはずのオブジェクト内に残ったままになってしまうおそれがあります。