現在のフェーズ:
結果が発表されました。タイムラインをご覧ください。
このページは、組織の申請プロセスの調査フェーズにあるオープンソース組織を対象としています。これらのプロジェクトのアイデアは、組織のプロジェクト アイデアのページで、考えられるドキュメント プロジェクトについて組織が説明する方法を示す単なる例です。組織はこのリストに含まれていないプロジェクトを提案することもできます。
プロジェクトのアイデア: コントリビューターのオンボーディング ガイドを作成する
問題
- 新しいコントリビューターは、プロジェクトに有意義な貢献をするために必要な設定情報を見つけることができません。一部のプロセス（テストへの貢献など）は、まったく文書化されていません。
成果をどのように測定するのか
- 新規コントリビューター数の増加率
- コード以外の新規コントリビューター数の増加（ドキュメントやテストに貢献しやすくなるため）
- 新しいコントリビューターから報告される問題の減少
- 「good first issue」のタグが付けられたクローズ済みの問題の増加
このプロジェクトで働く技術ライターにはどのようなスキルが必要ですか？
- 必須: GitHub に精通している（または GitHub チュートリアルを学習する意欲がある）
- 推奨: テスト実行のためのテストランナーと、そのためのドキュメントの更新に関する知識がある
ボランティア
コミュニティ メンバーに、特定のタスク（以下に例を示します）のサポートに登録するよう促します。
- @JaneQDev がテストに関する質問への回答を手伝ってくれます。
- @ChenPCoder、ドキュメントの pull リクエストを確認いたします
- @ErichJEngineer、テクニカル ライターと現在の投稿プロセスについて確認できますか？
連絡先情報
- このプロジェクトに参加することに興味をお持ちの技術ライターは、email@project にメールを送信してください。テクニカル ライティングの作品またはポートフォリオ、履歴書、履歴書へのリンクを記載してください。
プロジェクトのアイデア: ライブラリを次のようなもので使用するチュートリアルを作成します。
問題
- プロジェクトでは、$TechnologyX でライブラリを使用しようとしたユーザーから多くの問題が報告されています。$TechnologyX との統合に関する明確なガイドはなく、利用が難しい場合があります。
成果をどのように測定するのか
- 「$TechnologyX」のタグが付けられた問題の減少
- $TechnologyX に関するバグの修正やドキュメントの追加に役立つ、新しいコントリビューターからのプルリクエスト数の増加
- $TechnologyX プロジェクトからプロジェクトへのその他のリンク
このプロジェクトに取り組むには、テクニカル ライターにどのようなスキルが必要ですか。
- 推奨: $TechnologyX に精通している
ボランティア
コミュニティ メンバーに、特定のタスク（以下に例を示します）のサポートに登録するよう促します。
- @JaneQDev が $TechnologyX に関する質問への回答を手伝ってくれます
- @ChenPCoder、ドキュメントの pull リクエストを確認いたします
連絡先情報
- このプロジェクトに参加することに興味をお持ちの技術ライターは、email@project にメールを送信してください。技術的な文章の例やポートフォリオ、履歴書、職務経歴書へのリンクを記載してください。
プロジェクトのアイデア: ドキュメントを整理する
問題
- ドキュメントが膨大で整理されていない。多くのユーザーは、ドキュメントで回答を見つけることをあきらめ、代わりにフォーラムで問題を報告したり質問したりします。関連性の高いキーワードで検索しても そのページは検索結果に表示されません
成功をどのように測定するか
- ドキュメントの SEO を改善
- ドキュメントで説明されているトピックに関する問題の減少
- ドキュメントへの貢献数の増加
このプロジェクトで働く技術ライターにはどのようなスキルが必要ですか？
- 歓迎されるスキル: 大規模で成熟したドキュメント セットの再編成の経験、SEO の理解
ボランティア
コミュニティ メンバーに、特定のタスク（以下に例を示します）のサポートに登録するよう促します。
- @ChenPCoder、ドキュメントの pull リクエストを確認
連絡先情報
- このプロジェクトに参加することに興味をお持ちの技術ライターは、email@project にメールを送信してください。テクニカル ライティングの作品、ポートフォリオ、履歴書、履歴書へのリンクを記載してください。
プロジェクトのアイデア: ドキュメントの修正を実行する
問題
- ドキュメントに関連する小さなバグや古い問題がたくさんあります。コミュニティのメンバーは、クリーンアップに協力しますが、実際の Fixit を組織して運営する担当者が必要です。
成果をどのように測定するのか
- ドキュメント関連の問題のクローズ数
- ドキュメントへの投稿数と新しい投稿者の増加
このプロジェクトに取り組むには、テクニカル ライターにどのようなスキルが必要ですか。
- 推奨: ドキュメントの修正を実施した経験
- 優れた組織能力
ボランティア
コミュニティ メンバーに、特定のタスク（以下に例を示します）のサポートに登録するよう促します。
- @ChenPCoder: フィックスの動画とチャットを整理し、他のタイムゾーンのボランティアを見つける手助けをします
連絡先情報
- このプロジェクトに参加することに興味をお持ちの技術ライターは、email@project にメールを送信するか、フォーラムで問題を報告または質問してください。技術的な文章作成の作業、ポートフォリオ、履歴書、職務経歴書へのリンクを記載してください。
プロジェクトのアイデア: ドキュメントの監査
問題
- ドキュメントの状態はよくわかりません。ロードマップや、最も緊急の問題を把握していないため、ドキュメントの改善を優先することは困難です。また、削除またはアーカイブする必要がある古いコンテンツも多数あります。
成功をどのように測定するか
- コミュニティから一般的な承認を得て、ドキュメント・ロードマップを作成する
- 古いドキュメント ページや誤ったドキュメント ページの数を減らす
このプロジェクトで働く技術ライターにはどのようなスキルが必要ですか？
- 推奨: ドキュメント監査の経験
ボランティア
コミュニティ メンバーに、特定のタスク（以下に例を示します）のサポートに登録するよう促します。
- @JaneQCoder は、コミュニティ ミーティングでドキュメント ロードマップのプレゼンテーションを調整するのを手伝ってくれます。
連絡先情報
- このプロジェクトに参加することに興味をお持ちの技術ライターは、email@project にメールを送信するか、フォーラムで問題を報告または質問してください。技術的な文章作成の作業、ポートフォリオ、履歴書、職務経歴書へのリンクを記載してください。
関連情報
- [プロモーションとプレス] ページには、Google Season of Docs について説明する際に使用できるロゴなどのコンテンツが含まれています。
- PyCon Australia 2017 の動画「What nobody tells you about documentation」では、ユーザーにとって有用なドキュメントを作成するためのヒントが Daniele Procida 氏によって紹介されています。