ドキュメンテーション・マラソンは、オープンソース・プロジェクトのドキュメンテーションを作成または改善するための素晴らしい方法です。
オープンソースプロジェクトのドキュメンテーションは、顧客にとって非常に重要です。対象となる利用者は、プロジェクトの目的とそれがどのように利用されるかを理解しなければなりません。ドキュメンテーションは、そのギャップを埋めるためのツールです。プロジェクトが本当に完成することは稀なので、プロジェクトが改善され続けるにつれて、リソースが維持され更新されることも同様に重要です。
しかし、維持しなければならない文書がたくさんあるにもかかわらず、それを最新に保つためのリソースが不足している場合はどうなるでしょうか？答えは簡単です！
ドカソンとは何ですか？
ドキュメンテーション・マラソンとは.ハッカソンは、エンジニアとコミュニティのリーダーが集まって、既存のアプリケーションを改良したり、新しい機能を追加したりするイベントです。ドキュメンテーションマラソンでは、同じコラボレーションがドキュメンテーションの改善に焦点を当てます。
ドキュメントマラソンは、コンテンツのギャップを埋めたり、大規模なドキュメントセットを再編成したり、リンク切れを修正したり、誤字脱字を修正したりすることができます。ドキュメントマラソンの目的は、比較的短期間で多数のドキュメントを改善することです。
製品ドキュメントの例としては、以下のようなものがあります：
- トレーニングマニュアル
- ユーザーマニュアル
- インストレーションガイド
- トラブルシューティングガイド
- クイックスタートガイド
- API ドキュメンテーション
- チュートリアル
ドキュメントマラソンで実現できること
私がドカソンを開催する理由のトップ3をご紹介します：
バックログの削減
ほとんどのドキュメンテーションは、サポートする製品とともに進化しなければなりません。製品が変更されたり更新されたりすると、ドキュメンテーションも変更されなければなりません。場合によっては、ドキュメンテーションチームは、エンジニアリングチームのリリースサイクルに合わせてドキュメンテーションの新バージョンをリリースします。チーム内で優先順位が変わり、 GA 続くと、ドキュメンテーションチームは、新機能、バグ修正、タスクの完了に追いつくことが難しくなります。放棄された変更は、後で完了する必要のある作業の蓄積であるバックログの一部となります。
ヒント： ドキュメンタソン期間中、参加者は滞留している項目をトリアージし、リスト上で完了させることができます。技術者以外の参加者は、誤字脱字、リンク切れ、その他のテキスト関連の問題の修正に取り組むことができます。
大規模改修の手引き
ドキュメンテーション・チームがガイドの改訂時期に気づいたときには、ガイドが数章、数百ページになっていることもあります。コンテンツプランが出来上がると、複雑な再編成が始まります。大量のドキュメントの再編成は、気の弱い人には向いていません。
ヒント： ドキュメンテーションマラソンをリードするチームを結成し、異なるチームや部門から組織全体で参加するインセンティブを提供します。作業範囲や時間的制約にもよりますが、チームは思ったよりも短時間でガイド全体の再編成を成功させることができます。
部門を超えたチーム間の協力
組織内のさまざまなチームが孤立して仕事をするのはよくあることです。エンジニアリング、製品、カスタマーサポート、マーケティング、ドキュメンテーションの各チームは、プロジェクトで必要なほど頻繁にコラボレーションしていないかもしれません。
各チームメンバーがそれぞれの専門知識を活かして製品ドキュメントを改善するイベントを開催することを想像してみてください。ドキュメントマラソンは、多様性、リアルタイムのコラボレーション、専門家同士のコミュニケーションを促進します。また、地理的に異なる場所に住む人々が、直接または遠隔で参加できる包括的な環境も実現します。ドキュメントは、異なる視点や専門性を持つエキスパートの注目を集め、孤立したサイロ、無意識の偏見、燃え尽き症候群を最小限に抑えます。
ヒント： 部門を超えたチームを共通の目的のために結集させること。
ドキュメントマラソン
今度、チームが乗り越えられないようなバックログを抱えていたり、巨大な文書化プロジェクトの再編成を任されたりしたら、文書化マラソンの開催を検討してみてください。簡単で、その生産性には驚くかもしれません。このようなイベントを開催するための詳細については、Tiffany Longの 素晴らしい 10ステップガイドをお読みください。
///--on
