Проект OpenMRS.org

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:
OpenMRS.org
Технический писатель:
Айешманта
Название проекта:
Разработка удобной для пользователя документации GithHub для REST API
Длина проекта:
Стандартная продолжительность (3 месяца)

Описание проекта

Основная цель проекта — разработать интерактивную документацию, в которой конечные пользователи смогут взаимодействовать с API с вариантами опробования и в то же время иметь более описательное и самообъясняющее описание, которое объясняет техническим и нетехническим специалистам, в какой ситуации следует использовать конечную точку.

Текущая среда чванства великолепна, но для нетехнарей и технарей по-прежнему труднее получить представление напрямую без надлежащей документации. Основная идея заключалась в том, чтобы собрать эту чванливую среду и документацию в одном месте с хорошим представлением. С помощью JS, HTML и CSS.