現在のフェーズ:
結果が発表されましたタイムライン。
このページは、組織の申請プロセスの探索フェーズにあるオープンソース組織を対象としています。これらのプロジェクトのアイデアは、組織のプロジェクトアイデアページで、考えられるドキュメント プロジェクトをどのように説明するかを示すほんの一例です。組織はこのリストに含まれていないプロジェクトを提案できます。
プロジェクトのアイデア: コントリビューターのオンボーディング ガイドを作成する
問題
- 新規のコントリビューターが、プロジェクトに有意義な貢献を行うために必要な設定情報が表示されません。一部のプロセス（テストへの貢献など）がまったく文書化されていません。
成果をどのように測定するか
- 新規投稿者の増加率
- コード以外の新たな貢献者数の増加（ドキュメントやテストへの貢献が容易になる）
- 新しい投稿者によって提起された問題の数が減少する
- 「適切な最初の問題」でタグ付けされたクローズ済みの問題の数が増加
テクニカル ライターがこのプロジェクトで必要となるスキルは何ですか。
- 必須: GitHub に精通していること（または GitHub チュートリアルに取り組む意思）
- 知っておきたいこと: テストを実行し、そのためのドキュメントを更新できるようにするため、テストランナーに精通していること
ボランティア
コミュニティ メンバーに、以下のような特定のタスクのサポートに登録するよう促します。
- @JaneQDev は、テストに関する質問に答えるのを手伝ってくれます
- @ChenPCoder、ドキュメントの pull リクエストの確認に喜びを:
- @ErichJEngineer は、現在の貢献プロセスをテクニカル ライターとともに説明できます。
連絡先情報
- このプロジェクトに関心をお持ちのテクニカル ライターは、email@project にメールを送信してください。テクニカル ライティングの資料、ポートフォリオ、履歴書、CV へのリンクをご記入ください。
プロジェクトのアイデア: ライブラリを使用するチュートリアルを作成して ...
問題
- 私たちのプロジェクトは、$TechnologyX でライブラリを使用しようとするユーザーから多くの問題に直面しています。$TechnologyX との統合をわかりやすく説明するガイドがないため、一筋縄ではいきません。
成果をどのように測定するか
- 「$TechnologyX」とタグ付けされた問題の数が減少
- 新しいコントリビューターからの pull リクエストの数が増加し、$TechnologyX に関するバグ修正やドキュメントの追加に役立った
- $TechnologyX プロジェクトの私たちのプロジェクトへのリンク
テクニカル ライターがこのプロジェクトで必要となるスキルは何ですか。
- 推奨: $TechnologyX にある程度の知識があること
ボランティア
コミュニティ メンバーに、以下のような特定のタスクのサポートに登録するよう促します。
- @JaneQDev は、$TechnologyX に関する質問への回答をサポートします
- @ChenPCoder、ドキュメントの pull リクエストの確認に喜びを:
連絡先情報
- このプロジェクトに関心をお持ちのテクニカル ライターは、email@project にメールを送信してください。テクニカル ライティングの作業またはポートフォリオ/履歴書/経歴へのリンクを記載してください。
プロジェクトのアイデア: ドキュメントを再構成する
問題
- ドキュメントは膨大で、まとまりがありません。多くのユーザーはドキュメントで答えを探すことをあきらめ、問題を提起したり、フォーラムで質問したりします。自分のページは、関連性のあるキーワードでも検索結果に表示されません。
成果をどのように測定するか
- ドキュメントの SEO の改善
- ドキュメントに記載されているトピックに対して提起された問題の件数が減少
- ドキュメントの投稿数の増加率
テクニカル ライターがこのプロジェクトで必要となるスキルは何ですか。
- 推奨: 大規模で成熟したドキュメント セットの整理の経験、SEO に関する理解
ボランティア
コミュニティ メンバーに、以下のような特定のタスクのサポートに登録するよう促します。
- @ChenPCoder、ドキュメントの pull リクエストの確認に喜びを:
連絡先情報
- このプロジェクトに関心をお持ちのテクニカル ライターは、email@project にメールを送信してください。テクニカル ライティングの作業またはポートフォリオ/履歴書/経歴へのリンクを記載してください。
プロジェクトのアイデア: ドキュメント修正プログラムの実行
問題
- ドキュメントには小さなバグや古い問題がたくさんあります。私たちのコミュニティは喜んでクリーンアップの手助けをしますが、実際の修正を整理して実行する人が必要です。
成果をどのように測定するか
- クローズされたドキュメント関連の問題の件数
- ドキュメントのコントリビューション数と新しいコントリビューターの増加
テクニカル ライターがこのプロジェクトで必要となるスキルは何ですか。
- 推奨: ドキュメント修正プログラムを実行した経験
- 優れた業務処理能力
ボランティア
コミュニティ メンバーに、以下のような特定のタスクのサポートに登録するよう促します。
- @ChenPCoder の動画やチャットを 主催して、他のタイムゾーンにいるボランティアを
連絡先情報
- このプロジェクトに関心をお持ちのテクニカル ライターは、Google のフォーラムで email@project にメール/問題を公開/質問してください。テクニカル ライティングの資料、ポートフォリオ/履歴書/経歴書へのリンクを記載してください。
プロジェクトのアイデア: ドキュメントの監査を行う
問題
- ドキュメントの状態がよくわかりません。最も差し迫った問題に関するロードマップやセンスがないため、ドキュメントの改善に優先順位を付けるのは困難です。また、削除またはアーカイブすべき古いコンテンツも数多くあります。
成果をどのように測定するか
- コミュニティでの一般的な承認を得てドキュメント ロードマップを作成する
- ドキュメントの古いページや不正確なドキュメント ページが減少
テクニカル ライターがこのプロジェクトで必要となるスキルは何ですか。
- 推奨: ドキュメント監査の経験がある
ボランティア
コミュニティ メンバーに、以下のような特定のタスクのサポートに登録するよう促します。
- @JaneQCoder は、コミュニティ ミーティングでのドキュメント ロードマップのプレゼンテーションについて調整できます。
連絡先情報
- このプロジェクトに関心をお持ちのテクニカル ライターは、Google のフォーラムで email@project にメール/問題を公開/質問してください。テクニカル ライティングの資料、ポートフォリオ/履歴書/経歴書へのリンクを記載してください。
関連情報
- プロモーションとプレスのページには、Google ドキュメントのシーズンを紹介する際に使用できるロゴやその他のコンテンツが含まれています。
- PyCon Australia 2017 のこの動画では、ドキュメントを整理するためのヒントが示されています（Daniele Procida による What do nobody know about documents）。