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