На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- OpenMRS
- Технический писатель:
- Радуга
- Название проекта:
- Улучшение технической документации OpenMRS для новых разработчиков
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Обоснование
Поскольку мир страдает от последствий пандемии COVID-19, становится еще более очевидным, что система медицинских записей с открытым исходным кодом, такая как OpenMRS, может стать частью решения такого рода кризиса. Чтобы помочь новым разработчикам ориентироваться в экосистеме OpenMRS, сократить процесс адаптации и дать возможность большему числу новичков быстро внести свой вклад в разработку OpenMRS, необходимо иметь краткую, понятную и актуальную документацию. Для новых разработчиков существует два документа: • Начало работы в качестве разработчика • Руководство разработчика Однако часть содержания устарела, а формат нуждается в улучшении. Целью этого проекта является обновление содержания и улучшение формата этих двух документов, чтобы сделать их более удобными для пользователя.
Объем
- Реорганизуйте и переформатируйте содержимое этих двух документов. Для документа «Начало работы в качестве разработчика»: a. Разделите 17 шагов инструкции на разделы, каждый раздел содержит меньше шагов, чтобы пользователю было легче следовать. б. Измените порядок шагов; некоторые этапы можно объединить. в. Ссылки на другие вики-страницы перечисляйте в таблицах, чтобы инструкции были более краткими и читабельными.
Для Руководства разработчика: a. Справочную информацию OpenMRS в первых нескольких главах можно сократить, пользователей можно направить на страницу OpenMRS.org для получения более подробной информации. б. Главу «Настройка» следует переместить вверх перед главой «Процесс разработки».
Обновите содержимое. Для документа «Начало работы в качестве разработчика»: a. Обновите среду, настроенную для Linux и Windows (представьте Docker) b. Обновите конфигурацию IDE для IntelliJ и Eclipse c. Ссылка на руководство разработчика или руководство разработчика, где это применимо. д. Убедитесь, что все содержимое ссылок актуально.
Для Руководства разработчика: a. Представьте рабочий процесс разработки. б. Познакомить с тем, как организованы команды разработчиков, как члены команды работают вместе; добавлять ссылки на встречи команды, командные обсуждения; помогите новым разработчикам найти команды, к которым они, возможно, захотят присоединиться. в. Добавьте Docker в главу настройки системы. д. Добавьте более подробную информацию о различных типах модулей (эталонный модуль приложения, модуль OWA и модуль платформы), а также о том, как они работают вместе. е. Добавьте простые примеры кода, чтобы показать, как создаются и развертываются модули каждого типа. ф. Добавьте простые тестовые примеры для каждого типа модулей.
Анализ аудитории
Целевой аудиторией «Начала работы в качестве разработчика» и «Руководства разработчика» являются разработчики, мало или совсем не знающие OpenMRS. Могут быть два типа разработчиков: первый тип аудитории — это младшие разработчики с небольшим опытом разработки программного обеспечения или вообще без него. Например, студенты GSoC, которые ищут реальные проекты, чтобы узнать о разработке программного обеспечения с открытым исходным кодом. Для этих разработчиков эти два документа должны содержать достаточно подробностей и ссылок, чтобы они могли начать заполнять пробелы в знаниях и начать вносить свой вклад в проекты OpenMRS за относительно короткий период времени. Основными целями младших разработчиков являются: 1. Понять навыки, необходимые для участия в OpenMRS (MySQL, Java Spring. React.js, Git и т. д.) и найти ресурсы для изучения этих навыков. 2. Присоединяйтесь к сообществу OpenMRS, изучите инструменты коммуникации. 3. Настройте среду и IDE. 4. Установите OpenMRS SDK. 5. Понять рабочий процесс разработки. 6. Создайте простой код для создания новых модулей. 7. Разверните вновь созданные модули. 8. Тестовые модули. 9. Используйте Git для создания запросов на включение. Второй тип аудитории — это разработчики среднего или старшего уровня, желающие настроить OpenMRS в соответствии с потребностями своей организации или внести свой вклад в OpenMRS. Для этих более опытных разработчиков эти два документа должны предоставить обзор OpenMRS и служить руководством, которое направит их к более подробной информации о технологиях в Руководстве разработчика и других ресурсах. Основные цели опытных разработчиков: 1. Понять модель данных и архитектуру OpenMRS. 2. Присоединиться к сообществу OpenMRS, изучить инструменты коммуникации. 3. Найдите ссылки на репозитории кода OpenMRS. 4. Найдите более подробные ресурсы.
План проекта
Этап планирования: • Уточнить цели, установленные в разделе «Объем» • Выявить устаревшее содержание • Составить схемы для двух документов • Представить схему наставнику и профильным экспертам (SME) • Обновить план проекта
Этап разработки контента. • Изучите Docker, пройдите все этапы установки и создайте простой пример кода/тестового кода. • Опросите представителей малого и среднего бизнеса, чтобы задать вопросы. • Разработайте первый черновой вариант двух документов.
Проверка и публикация контента. • Самостоятельное редактирование содержимого. • Отправка завершенных черновиков рецензентам (наставникам и предприятиям малого и среднего бизнеса) и конечным пользователям для обратной связи. • Пересмотр черновика. • Опубликуйте два документа на вики-странице OpenMRS. • Написать отчет о проекте
Предварительная работа
Я проделал некоторую работу по настройке среды разработки в системе Linux и настройке OpenMRS SDK. Я занимаюсь настройкой IDE. Я продолжу работать над созданием простых модулей и написанием тестового кода.
Ссылки и обсуждения
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy -for-new-developer-learner/18861/14 https://talk.openmrs.org/t/ Looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https ://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947