このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Global Wordnet Association
- テクニカル ライター:
- Yoyo Wu
- プロジェクト名:
- Wordnet の構造
- プロジェクト期間:
- 標準の期間（3 か月）
プロジェクトの説明
このプロジェクトの目的
私は言語学を専攻するテクニカル ライターとして、さまざまな言語を統一された意味概念フレームワークで結びつけるという考えをもつプロジェクトを見つけたことに喜びを感じ、Google 翻訳のような現実世界のビジネスに適用されてきました。このプロジェクトのドキュメントに貢献して、視聴者にとってより使いやすくしたいと考えています。
問題
元のドキュメントを確認しましたが、以下の問題を解決することで改善できると思います。 WordNet の基本を紹介する概要セクションが最初にありません。これは初心者にとって有用なものです。 Wordnet 内のすべての関係は統一されたテンプレートでロールアウトされていますが、例やテストなどの必要な情報が不足している関係もあります。これらの情報は、プリンストン Wordnet のウェブページ、EuroWordnet の一般的なガイドライン、その他のリソースで提供されています。簡単な定義と定義、簡単な例と例には統一された文のパターンがありません。簡単な定義と簡単な例は、ユーザーが特定の関係にマウスをホバーしたときに表示されるコールアウトであり、定義と例は関係を紹介する主な役割を果たします。そのため、統一されたパターンで構成する必要がありますが、短いパターンとは異なるパターンで構成する必要があります。テストは EWN から取得されますが、ユーザーは常に条件を先に確認して、言語データが条件と一致するかどうかを判断してからテストを受けるため、条件ブロックはメインのテスト本文の前に配置する必要があります。テストの本文も、多くの言語の頭字語が含まれているため、それほど簡単ではありません。コメント セクションの内容は多様で、定義の特定のポイントを強調する場合もあれば、プロジェクト固有の詳細を記載する場合もあります。このセクションの標準を設定すべきだと思います。特定のプロジェクトに関する情報を [プロジェクト固有の名前] セクションに移動すると、ユーザーにとって便利になります。 [プロジェクト固有の名前] セクションには、すべてのプロジェクトの関係名の概要が表示されます。このセクションは、不一致エラーが発生するため確認する必要があります。用語集をドキュメントに直接リンクし、初心者になじみのない略語や用語をすべて追加する必要があります。
ガイドライン
また、ドキュメントの下書きを作成する前に、以下の 2 つのトピックについてプロジェクト チームと話し合いたいと思っています。得られた結論は、プロジェクト全体の一般的なガイドラインとして使用されます。
対象読者について 私自身を例に挙げましょう。私は言語学を専攻していますが、元のドキュメントに初めて出会ったとき、「synset」の意味を知りませんでした。synset の意味は Princeton Wordnet のウェブページで見つけました。
そのため、まず、潜在的なオーディエンスの知識構造を把握する必要があります。すべてのオーディエンスが関連する知識を備えていることを確認できない場合は、少なくとも概要セクションを追加し、用語集やその他の関連リソースをリンクして、WordNet とその関連プロジェクトを案内する必要があります。ドキュメント作成プロセス全体を通して、この前提を常に念頭に置く必要があります。
ドキュメントの機能について 私の理解では、WordNet 構造のドキュメントの目的は、WordNet 内のすべての関係タイプをユーザーが理解できるようにすることです。ユーザーは、提供された情報に基づいて単語を関係にグループ化できます。ただし、元のドキュメントは学術論文の抜粋に近いものです。ドキュメントの目的が学術的な参考資料である場合は問題ありませんが、ユーザーをガイドすることを目的としている場合は、学術性と有用性との間でトレードオフが必要です。
利点
ドキュメントの中国語版の翻訳をお手伝いいたします。言語学論文を英語から中国語に翻訳した経験があります。ドキュメントのフォーマット設定をサポートできます。HTML/CSS の基本を理解しており、サイドナビゲーション バーの追加など、ドキュメントのウェブページの見栄えを良くするサポートも可能です。フローチャートによって関係をより理解しやすくなる場合は、Visio または Mermaid を使用してフローチャートを作成いたします。
マイルストーン / 時間 / 目標
- 週 1: プロジェクト チームと目標、ワークフロー、作業計画について話し合い、確定します。
- 2 週目: ドキュメントの概要を固め、[概要] セクションを作成します。
- 第 3 週 – 第 4 週: 構成関係のパートを書きます。
- 第 5 週～第 6 週: その他の関係とドメインの関係の部分を記述します。
- 週 7 ～ 8: ロールの関係部分を記述します。
- 第 9 週: 残りの 3 つのリレーションを記述し、用語集を更新します。
- 10 週目: 必要に応じて中国語版を翻訳します。
- 11 週目: ドキュメントの形式を修正します。
- 12 週目: このプロジェクトの最終確認と要約。