このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Global Wordnet
- テクニカル ライター:
- Kumar
- プロジェクト名:
- Open Multilingual Wordnet(OMW)
- プロジェクトの長さ:
- 標準期間(3 か月)
プロジェクトの説明
プロジェクト リクエスト:
Global Wordnet Association のメンタルに連絡し、プルリクエストを送信しました。そのリクエストはメンタルから好意的に審査されました。機会があれば、このプロジェクトに週 40 時間(またはそれ以上)を費やすことができます。Python、Git、HTML、C++、Java、C をよく理解しています。私はバイリンガルで、英語とヒンディー語が堪能です。学校でフランス語を学んだし、ドイツ語も少し知っています。機会があれば、このプロジェクトを通して Global Wordnet Association に貢献したいと思っています。
現在の状態:
現在の Open Multilingual Wordnet のドキュメントは浅く、既存のユーザーガイドにはコンテンツ、グラフィック、例、明確な手順が欠けています。WordNet の検索方法、返されたページの読み方、インストール方法、フィードバックの提供方法を説明するユーザーガイドがない。新しい Wordnet の提供に関するドキュメントはありますが、そのドキュメントは Open Multilingual Wordnet に参加する方法について、完全でも明確でもありません。コラボレーション インターリンガル インデックス(CILI)を操作する方法に関するドキュメントはありません。CILI の概要ページには、コンセプトの非推奨化と置き換えの理由や方法、新しい候補の判断に関する情報がありません。全体的に、現在のドキュメントにはコンテンツ、明確さ、例、支援のためのビジュアルが不足しています。
計画:
このプロジェクトは 4 つのフェーズで実施する予定です。フェーズ A では、新しい WordNet を投稿するユーザー向けのガイドを作成します。このフェーズでは、適切な形式の WordNet を作成する方法、アップロードする方法、フィードバックを理解する方法について説明します。次のフェーズ B では、WordNet(または WordNet ファミリー)を検索するユーザー向けのガイドを作成します。このドキュメントでは、返されたページの読み取り方法、ダウンロード方法、フィードバックの提供方法について説明します。フェーズ C では、Collaborative Interlingual Index の操作方法、コンセプトの非推奨化と置き換え方法、新しい候補の評価方法を記述します。フェーズ D では、Open Multilingual Wordnet のドキュメントにデータを入力し、フェーズ A、B、C で説明されているドキュメントを除く、このプロジェクトの既存のドキュメントを改善します。GWA のプロジェクト間には重複があるため、フェーズ D では組織の要件にも対応します。フェーズ A には 1、2、3 週目、フェーズ B には 4、5、6 週目、フェーズ C には 7、8、9 週目、フェーズ D には 10 週目と 11 週目を割り当てる予定です。
プロジェクトの目標:
1)既存のドキュメントを分析し、改善が必要なセクションを特定します。
2)既存のドキュメントの構造の再構築。
3)新しいワードネットに貢献する人のためのガイドを文書化する。
4)WordNet を検索するユーザー向けのガイドを作成します。
5)Collaborative Interlingual Index の操作に関するガイドを作成します。
6)ドキュメントに例とビジュアルを追加しました。
7)ドキュメントが浅いと思われる既存のページに情報を追加する。
Timeline:
コミュニティ ボンディング フェーズ: 8 月 17 日~ 9 月 13 日
- この期間は、コミュニティと交流し、コミュニティをより深く知る予定です。
- コミュニケーション チャネルを設定する。
- 連絡時間を設定します。
- 目標を絞り込み、双方に今後の流れを伝えます。
ドキュメント開発フェーズ(9 月 14 日~ 11 月 30 日)
- メンターと緊密に連携し、週次計画に沿ってこのフェーズのプロジェクトを完了します。
- Google プログラム管理者からのアンケートに回答します。
第 1 ~ 3 週(9 月 14 ~ 27 日)
- ドキュメント フェーズ A
第 1 週(9 月 14 ~ 20 日)
- 新しい WordNet を投稿するユーザー向けのガイドのドキュメントが開始されます。
- 今週は、適切な形式の Wordnet を作成する方法を文書化します。
- ユーザーの Wordnet を公開 Wordnet LMF ドキュメント タイプ定義(DTD)に変換するための明確な手順が記載されます。
- コンバージョン ツールについても説明します。
第 2 週(9 月 21 ~ 27 日)
- 今週は、Wordnet LMF ドキュメント タイプ定義に変換した後、Wordnet を OMW にアップロードする方法について説明します。
- 既存のドキュメントは内容が浅く(ただし正確です)例を追加して充実させます。
第 3 週(9 月 28 日~ 10 月 4 日)
- この 1 週間は、フィードバックを理解する方法を文書化するために使用します。
- このトピックに関する既存のドキュメントがないため、このドキュメントはゼロから作成する必要があります。
第 4 ~ 6 週(10 月 5 ~ 25 日)
- ドキュメント作成フェーズ B
第 4 週(10 月 5 ~ 11 日)
- 今週は、WordNet(または WordNet ファミリー)を検索するユーザー向けのガイドの作成を開始します。
- 今週は、返されたページの読み取り方法に関するドキュメントを作成します。
第 5 週(10 月 12 ~ 18 日)
- 今週は、ダウンロード方法を説明します。
- そのためのドキュメントは存在しないため、ゼロから作成する必要があります。
第 6 週(10 月 19 ~ 25 日)
- 今週は、組織にフィードバックを提供する方法を説明します。
- 参照できる以前のドキュメントがないため、こちらもゼロから作成する予定です。
第 6 ~ 9 週(10 月 26 日~ 11 月 15 日)
- 文書化フェーズ C
第 7 週(10 月 26 日~ 11 月 1 日)
- 今週は、Collaborative Interlingual Index(CILI)の操作に関するガイドのドキュメントを作成します。
- 今週は、コンセプトを非推奨にして置き換える方法と理由について説明します。
第 8 週(11 月 2 ~ 8 日)
- 今週は、CILI に関する追加情報を記録し、CILI ドキュメントに CILI をダウンロードして組織の要件を満たす方法の手順を記述します。このドキュメントはゼロから作成する必要があります。
第 9 ~ 11 週(11 月 9 ~ 29 日)
- ドキュメント フェーズ D
第 9 週(11 月 9 ~ 15 日)
- OMW 2.0 は、組織のニーズに応じて開発されます。
第 10 週(11 月 16 ~ 22 日)
- Open Multilingual Wordnet(OMW)のホームページのドキュメントが薄いと思われます。今週は、OMW に関連する追加情報を追加し、他の OMW の既存のページに入力する必要があるページを確認します。
- 不足している OMW ページは改善され、可能な限りビジュアルを追加するようにします。
第 11 週(11 月 23 ~ 29 日)
- GWA のプロジェクトが重複しているため、この週は、組織の重複するニーズやその他のさまざまなドキュメントに対応するために確保されています。
プロジェクトの最終調整と評価のフェーズ(11 月 30 日~ 12 月 5 日)
- 今週は、ドキュメントの誤字脱字やエラーの校正に費やします。
- プロジェクト レポートを作成します。
- メンターにプロジェクト レポートの確認を依頼します。
- プロジェクト レポートを完成させて送信します。
- メンターと Season of Docs のエクスペリエンスに関する評価を書いて提出します。
コミュニケーション:
連絡の頻度は、メンターとの話し合いによって異なります。定期的なコミュニケーションをおすすめします。週に 2 回、最新情報を提供して、これまでの作業に関するフィードバックを得ることをおすすめします。ただし、これはユーザーの好みによって柔軟に変更できます。
このプロジェクトの目的
言語学に興味があり、世界中のあらゆる言語のワードネットをつなぐアイデアが生まれ、Global Wordnet Association に参加し、このプロジェクトに貢献しました。Open Multilingual Wordnet のコンセプトは素晴らしいものです。個々の Wordnet が他の言語の Wordnet にリンクされているため、これらの Wordnet に簡単にアクセスできます。Open Multilingual Wordnet とそのコンポーネントは、誰でも任意の目的で自由に使用、変更、共有できます。GWA は確かなアイデアと崇高な目的を持っていますが、あまり知られておらず、過小評価されています。おそらく理由の一つは、ドキュメントが浅く、投稿や使用に役立つユーザーガイドがないことです。Open Multilingual Wordnet プロジェクトは、Global Wordnet Association とオープンソース コミュニティの両方に貢献できるプロジェクトだと感じました。
今後の計画:
GSoD 20 の終了後も、他のプロジェクトでも Global Wordnet Association に貢献していきます。機会があれば、組織のあらゆる会議に参加したいと思います。