本页面包含有关 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
主页：
包含以下部分（概要视图）：
此 API 的实用功能概览
REST 简介
简单示例
身份验证信息
如何使用各种 HTTP 方法构建网址简介
有关必需参数和可选参数及其在自动生成的端点文档中的位置的信息。
指向以下培训页面的链接：https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
培训课程中使用的 helper_functions 信息
后续页面
根据主页面中列出的主题的复杂程度，某些主题可能需要链接到后续的详情页面。