Проект OpenMRS.org
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- OpenMRS.org
- Технический писатель:
- Айешманта
- Название проекта:
- Разработка удобной для пользователя документации GithHub для REST API
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Основная цель проекта — разработать интерактивную документацию, в которой конечные пользователи смогут взаимодействовать с API с вариантами опробования и в то же время иметь более описательное и самообъясняющее описание, которое объясняет техническим и нетехническим специалистам, в какой ситуации следует использовать конечную точку.
Текущая среда чванства великолепна, но для нетехнарей и технарей по-прежнему труднее получить представление напрямую без надлежащей документации. Основная идея заключалась в том, чтобы собрать эту чванливую среду и документацию в одном месте с хорошим представлением. С помощью JS, HTML и CSS.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0". Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2025-07-25 UTC."],[],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"]]
