|
オープンソースプロジェクトのドキュメントは、顧客にとって非常に重要です。ターゲットユーザーはプロジェクトの目的と使用方法を理解する必要があり、ドキュメントはそのギャップを埋めるツールとなります。プロジェクトが完全に完了することは稀であるため、プロジェクトが改善を続ける中で、リソースのメンテナンスと更新も同様に重要になります。 しかし、維持すべきドキュメントが大量にあるのに、それを最新の状態に保つためのリソースが不足している場合はどうすればよいでしょうか？答えは簡単です。ドキュメントマラソンを開催するのです！ ドキュメントマラソンとは何ですか?ドキュメンテーションマラソンはハッカソンのようなものです。ハッカソンは、エンジニアとコミュニティリーダーが集まり、既存のアプリケーションの改善や新機能の追加に取り組むイベントです。ドキュメンテーションマラソンでは、同様のコラボレーションがドキュメントの改善にも焦点を当てます。 ドキュメントマラソンでは、コンテンツのギャップを埋めたり、大量のドキュメントを整理したり、リンク切れを修正したり、あるいは単にタイプミスを修正したりすることができます。ドキュメントマラソンの目的は、比較的短期間で大量のドキュメントを改善することです。 製品ドキュメントの例としては次のようなものがあります。
私の組織では、ドキュメンテーションチームがドキュメンテーションマラソンを実施し、102ページのインストールガイドの改訂に成功しました。このドキュメンテーションマラソンにより、プロジェクトのスコープ、つまり再編成と簡素化、重複コンテンツの削除、そしてカスタマージャーニーの追跡に集中することができました。ドキュメンテーションマラソンの開催はチームに大きな感銘を与え、カスタマーサクセス率の向上にも繋がりました。 ドキュメンテーションマラソンでできる3つのこと私がドキュメント マラソンを開催する主な理由は次の 3 つです。 1. バックログを削減するほとんどのドキュメントは、サポートする製品に合わせて進化する必要があります。製品が変更または更新されると、ドキュメントもそれに合わせて進化する必要があります。場合によっては、ドキュメントチームがエンジニアリングチームのリリースサイクルに合わせて新しいバージョンのドキュメントをリリースすることもあります。チーム内の優先順位が変化し、GAリリースが継続する中で、ドキュメントチームは新機能、バグ修正、タスクの完了に対応するという課題に直面しています。放棄された変更はバックログとなり、後で対応する必要がある作業の蓄積となります。
2. 大きなガイドを修正するドキュメンテーションチームがガイドラインの改訂時期だと気付いた時には、すでに数章、数百ページに及んでいるかもしれません。コンテンツプランが策定されると、複雑な再編成作業が始まります。大量のドキュメントの再編成は、決して容易なことではありません。
3. 部門横断的なチーム間の連携組織内の複数のチームが個別に作業を行うことは珍しくありません。エンジニアリング、製品、カスタマーサポート、マーケティング、ドキュメントの各チームが、プロジェクトにおいて必要な頻度で連携できていない場合があります。 チームメンバー全員が専門知識を活かして製品ドキュメントを改善できるイベントを開催することを想像してみてください。ドキュメントマラソンは、多様性、リアルタイムのコラボレーション、そして専門家（SME）間のコミュニケーションを促進します。また、地理的に離れた人々が直接またはリモートで参加できる、インクルーシブな環境を実現します。多様な視点と専門知識を持つ専門家があなたのドキュメントに注目することで、サイロ化、無意識の偏見、そして燃え尽き症候群を最小限に抑えることができます。
ドキュメントマラソンチームが手に負えないほどの仕事のバックログを抱えている時、あるいは大規模なドキュメンテーションプロジェクトの再編成を任された時は、ドキュメンテーションマラソンの開催を検討してみてください。簡単で、その生産性に驚くかもしれません。このようなイベントの開催について詳しくは、ティファニー・ロングによるハッカソン開催のための10ステップガイドをご覧ください。 |
