Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Ensemblierung
- Technischer Redakteur:
- Lorrelm
- Projektname:
- Dokumentation zur REST API
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Entwicklerhandbuch zur Verwendung der Ensembl REST API erweitern
Schwerpunkt: Bieten Sie eine nutzerfreundlichere Einführung/Erste Schritte.
Die vorgeschlagene Implementierung basiert auf den folgenden Dokumenten:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Hauptseite:
Enthält folgende Bereiche (übergeordnete Ansicht):
Übersicht über die praktischen Funktionen dieser API
Kurze Einführung in REST
Kurzes Beispiel
Authentifizierungsinformationen
Einführung in die Strukturierung von URLs mithilfe verschiedener HTTP-Methoden
Informationen zu den erforderlichen und optionalen Parametern und dazu, wo sie sich in der Dokumentation zum automatisch generierten Endpunkt befinden.
Link zur folgenden Schulungsseite: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informationen zu „helper_functions“, die im Kurs verwendet werden
Weitere Seiten
Je nach Komplexität der Themen auf der Hauptseite müssen einige Themen möglicherweise mit nachfolgenden Detailseiten verknüpft werden.