이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 구성:
- OpenMRS
- 테크니컬 라이터:
- 무지개
- 프로젝트 이름:
- 신규 개발자를 위한 OpenMRS 기술 문서 개선
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
근거
전 세계가 코로나19 팬데믹의 결과를 겪고 있는 지금, OpenMRS와 같은 오픈소스 의료 기록 시스템이 이러한 위기의 해결책이 될 수 있다는 사실이 더욱 분명해졌습니다. 새로운 개발자가 OpenMRS 생태계를 탐색하고 온보딩 프로세스를 단축하며 더 많은 신규 개발자가 OpenMRS 개발에 빠르게 기여할 수 있도록 하려면 간결하고 명확한 최신 문서를 갖추어야 합니다. 신규 개발자를 위한 기존 문서는 두 가지가 있습니다. • 개발자 시작하기 • 개발자 매뉴얼 그러나 일부 콘텐츠는 오래되었으며 형식이 개선되어야 합니다. 이 프로젝트의 목표는 두 문서의 콘텐츠를 업데이트하고 형식을 개선하여 더 사용자 친화적으로 만드는 것입니다.
범위
- 이 두 문서의 콘텐츠를 다시 구성하고 형식을 다시 지정합니다. 개발자 시작하기 문서: a. 안내의 17단계를 섹션으로 나누고 각 섹션에 단계를 더 적게 포함하여 사용자가 더 쉽게 따라할 수 있도록 합니다. b. 단계의 순서를 재정렬합니다. 일부 단계는 결합할 수 있습니다. c. 다른 위키 페이지에 대한 링크를 표에 나열하여 지침을 더 간결하고 읽기 쉽게 만듭니다.
개발자 설명서의 경우: a. 처음 몇 챕터의 OpenMRS 배경 정보는 줄일 수 있으며, 사용자는 OpenMRS.org 페이지로 이동하여 자세한 내용을 확인할 수 있습니다. b. 설정 챕터를 개발 프로세스 챕터 앞에 이동해야 합니다.
콘텐츠를 업데이트합니다. 개발자 시작하기 문서의 경우 다음 단계를 따르세요. a. Linux 및 Windows용 환경 설정 업데이트 (Docker 소개) b. IntelliJ 및 Eclipse의 IDE 구성을 업데이트합니다. 해당하는 경우 개발자 매뉴얼 또는 개발자 가이드 링크를 포함합니다. d. 모든 링크 대상 콘텐츠가 최신 상태인지 확인합니다.
개발자 매뉴얼의 경우: a. 개발 워크플로를 소개합니다. b. 개발팀의 구성 방식, 팀원들이 함께 협력하는 방식을 소개합니다. 팀 회의, 팀 토론 링크를 추가합니다. 신규 개발자가 참여하고 싶은 팀을 찾을 수 있도록 지원합니다. c. 시스템 설정 챕터에 Docker를 추가합니다. d. 다양한 종류의 모듈 (참조 애플리케이션 모듈, OWA 모듈, 플랫폼 모듈)과 이러한 모듈이 함께 작동하는 방식에 관한 세부정보를 추가합니다. 각 종류의 모듈이 빌드되고 배포되는 방식을 보여주는 간단한 예시 코드를 추가합니다. f. 각 모듈 유형에 간단한 테스트 예시를 추가합니다.
시청자 분석
개발자 시작하기 및 개발자 설명서는 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를 학습하고 모든 설치 단계를 진행한 후 간단한 예시 코드/테스트 코드를 작성합니다. • SME를 인터뷰하여 질문합니다. • 두 문서의 초안을 작성합니다.
콘텐츠 검토 및 게시 • 콘텐츠를 직접 수정합니다. • 완성된 초안을 검토자 (멘토 및 SME) 및 최종 사용자에게 보내 의견을 받습니다. • 초안을 수정합니다. • 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