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