コンテンツのワークフローについて
ドキュメントを作成する過程で、コンテンツはいくつかのステージを経ます。各ステージでは、それぞれに異なる役割を持つユーザーからの入力が必要です。
各オブジェクトにステータスが与えられ、そのステータスはお客様のデプロイで定義したワークフローに従って変化します。たとえば、トピックは次のワークフローの中でContributeからDoneに変化する場合があります。
オブジェクトのステータスから以下を理解することができます。
- ドキュメンテーション プロセスのどこに来ているか
- 次にどんな作業が必要か
- 完了前に何を完遂する必要があるか
各ユーザーが 1 つまたは複数の役割を持つ場合があります。たとえば、お客様のデプロイにはコントリビュータ、ライター、エディタ、レビュー担当者などの役割があるかもしれません。特定の役割に割り当てられたユーザーは、割り当てられたコンテンツに特定の方法で取り組むことが期待されます。
たとえば、お客様の組織では対象分野の専門家 (SME) がコンテンツを作成し、そのコンテンツがテクニカル ライターに送られて改良されることが期待されます。 完了すると、テクニカル ライターはコンテンツを専門家に戻し、専門家は必要に応じて検証および変更を行います。この場合、対象分野の専門家はコントリビュータとレビュー担当者の役割、テクニカル ライターはライターの役割を持つことが考えられます。
ワークフローの例
以下は、考えられるドキュメンテーションのワークフローの一例です。これ以外にも多数のワークフローが可能です。このプロセスはテクニカル ライターから始まりますが、この担当者はテクニカル ライター、情報アーキテクト、その他であることも考えられます。
- テクニカル ライターは 1 つのマップと複数のトピックを作成します。.
- テクニカル ライターはトピックに基本的なコンテンツを追加します。
- テクニカル ライターはトピックを対象分野の専門家に割り当て、専門家はコントリビュータの役割を持っています。
- テクニカル ライターは続いて、トピックのステータスをContributeに変更します。
- 対象分野の専門家が割当のロード ページを開くと、Contribute ステータスの割り当て済みトピックが作業する項目として表示されます。
- 対象分野の専門家が編集をクリックすると、トピックがリポジトリからチェックアウトされ、トピック エディタ内に開きます。
- 対象分野の専門家はトピック エディタ内のコンテンツを書き終えると、チェックインをクリックします。
- 対象分野の専門家はコンテンツ オブジェクトのステータスをWorkに変更し、割当をテクニカル ライターに戻します。
- テクニカル ライターはトピックの作業を行い、完了すると、トピックのステータスをReviewに変更し、割当を対象分野の専門家に戻します。
- 対象分野の専門家はトピック内のコンテンツをチェックします。専門家は新しい情報を追加するか、またはさらなる変更を推奨する場合があります。
- 完了すると、対象分野の専門家はトピックをチェックインし、ステータスをWorkに戻し、テクニカル ライターがコンテンツの作業または閲覧を行えるようにします。
- テクニカル ライターは、作業を完了すると、ステータスをCompleteに変更します。
- 完了したトピックをプロダクト マネージャーまたは情報アーキテクトが受け取り、Doneステータスにプッシュします。これは、必要に応じて発行したり、またはローカリゼーションのために送信したりできるようにするためです。