Ensembl 项目
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Ensembl
- 技术文档工程师：
- laurelm
- 项目名称：
- REST API 文档
- 项目时长：
- 标准时长（3 个月）
Project description
改进了使用 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 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2025-07-25。
[null,null,["最后更新时间 (UTC)：2025-07-25。"],[[["\u003cp\u003eThis project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers.\u003c/p\u003e\n"],["\u003cp\u003eThe 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.\u003c/p\u003e\n"],["\u003cp\u003eCertain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding.\u003c/p\u003e\n"],["\u003cp\u003eThis is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months.\u003c/p\u003e\n"]]],["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"],null,["# Ensembl project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: Ensembl\n\nTechnical writer:\n: laurelm\n\nProject name:\n: REST API documentation\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nEnhance the developer user guide for using the Ensembl REST API\n\n*** ** * ** ***\n\nMain focus -- Provide a more user friendly introduction/getting started section.\n\nProposed implementation is based along the lines of these doc pages:\n\n\u003chttps://developers.google.com/maps/documentation/maps-static/intro\u003e\n\n\u003chttps://developers.google.com/maps/documentation/maps-static/dev-guide\u003e\n\n*** ** * ** ***\n\n### Main page:\n\nIncludes these sections (high level view):\n\n- Overview of what this API provides in practical terms\n\n- Short intro to REST\n\n- A quick example\n\n- Authentication info\n\n- Introduction to how the URLs are structured using various HTTP methods\n\n- Info on the required and optional parameters and where they are found in the auto-generated endpoint documentation.\n\n- Link to the following training page:\n \u003chttps://www.ebi.ac.uk/training/online/course/ensembl-rest-api\u003e\n\n- Info on helper_functions that are used in the training course\n\n*** ** * ** ***\n\n### Subsequent pages\n\nDepending on complexity of the topics listed in the main page, some topics may need to link to subsequent detail pages.\n\n*** ** * ** ***"]]
