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