# Ensembl project

This page contains the details of a technical writing project accepted for
Google Season of Docs.

## Project summary

Open source organization:
:   Ensembl

Technical writer:
:   laurelm

Project name:
:   REST API documentation

Project length:
:   Standard length (3 months)

## Project description

Enhance the developer user guide for using the Ensembl REST API

*** ** * ** ***

Main focus -- Provide a more user friendly introduction/getting started section.

Proposed implementation is based along the lines of these doc pages:

<https://developers.google.com/maps/documentation/maps-static/intro>

<https://developers.google.com/maps/documentation/maps-static/dev-guide>

*** ** * ** ***

### Main page:

Includes these sections (high level view):

- Overview of what this API provides in practical terms

- Short intro to REST

- A quick example

- Authentication info

- Introduction to how the URLs are structured using various HTTP methods

- Info on the required and optional parameters and where they are found in the auto-generated endpoint documentation.

- Link to the following training page:
  <https://www.ebi.ac.uk/training/online/course/ensembl-rest-api>

- Info on helper_functions that are used in the training course

*** ** * ** ***

### Subsequent pages

Depending on complexity of the topics listed in the main page, some topics may need to link to subsequent detail pages.

*** ** * ** ***