アンサンブル プロジェクト
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Ensembl
- テクニカル ライター:
- laurelm
- プロジェクト名:
- REST API のドキュメント
- プロジェクトの長さ:
- 標準期間(3 か月)
プロジェクトの説明
Ensembl REST API の使用に関するデベロッパー ユーザーガイドを拡張
主な変更点 -- よりユーザー フレンドリーな導入/スタートガイドのセクションを追加しました。
提案されている実装は、次のドキュメント ページに基づいています。
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
メインページ:
次のセクションが含まれます(概要)。
以降のページ
メインページに表示されるトピックの複雑さに応じて、一部のトピックは後続の詳細ページにリンクする必要があります。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-11-08 UTC。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2024-11-08 UTC。"],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]