이 페이지에는 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 구성을 업데이트합니다. c. 해당하는 경우 개발자 매뉴얼 또는 개발자 가이드로 연결합니다. d. 링크의 모든 콘텐츠가 최신 상태인지 확인합니다.
개발자 설명서의 경우: a. 개발 워크플로를 소개합니다. b. 개발팀의 구성 방식과 팀 구성원이 함께 작업하는 방식을 소개하고, 팀 회의 및 팀 토론으로 연결되는 링크를 추가합니다. 새 개발자가 참여하고 싶은 팀을 찾을 수 있도록 돕습니다. c. 시스템 설정 장에서 Docker를 추가합니다. d. 다양한 종류의 모듈 (참조 애플리케이션 모듈, OWA 모듈, 플랫폼 모듈)과 함께 작동하는 방식을 자세히 설명합니다. e. 간단한 예시 코드를 추가하여 각 종류의 모듈이 빌드 및 배포되는 방식을 보여줍니다. 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을 사용하여 pull 요청을 만듭니다. 두 번째 대상은 조직의 니즈에 맞게 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://newstalk.gs-learner/18861/14 https://newtalk.gs-openrs28proving-82