Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- OpenMRS
- Người viết nội dung kỹ thuật:
- Cầu vồng
- Tên dự án:
- Cải thiện tài liệu kỹ thuật OpenMRS cho nhà phát triển mới
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Lý do
Khi thế giới đang phải gánh chịu hậu quả của đại dịch COVID-19, rõ ràng hơn nữa rằng một hệ thống hồ sơ y tế nguồn mở như OpenMRS có thể là một phần giải pháp cho loại khủng hoảng này. Để giúp các nhà phát triển mới khám phá hệ sinh thái OpenMRS, rút ngắn quá trình giới thiệu và tạo điều kiện cho nhiều nhà phát triển mới hơn có thể đóng góp nhanh chóng vào sự phát triển của OpenMRS, bạn cần phải có các tài liệu ngắn gọn, rõ ràng và cập nhật. Hiện có hai tài liệu dành cho nhà phát triển mới: • Bắt đầu với tư cách nhà phát triển • Hướng dẫn sử dụng cho nhà phát triển Tuy nhiên, một số nội dung đã lỗi thời và định dạng cần cải thiện. Mục tiêu của dự án này là cập nhật nội dung và cải thiện định dạng của hai tài liệu này để làm cho chúng thân thiện hơn với người dùng.
Phạm vi
- Sắp xếp lại và định dạng lại nội dung của hai tài liệu này. Đối với tài liệu Bắt đầu với tư cách nhà phát triển: a. Chia 17 bước trong hướng dẫn thành nhiều phần, mỗi phần sẽ có ít bước hơn để người dùng dễ làm theo hơn. b. Sắp xếp lại thứ tự các bước; có thể kết hợp một số bước. c. Liệt kê các đường liên kết tới các trang wiki khác trong bảng để hướng dẫn ngắn gọn và dễ đọc hơn.
Đối với Hướng dẫn sử dụng cho nhà phát triển: a. Thông tin cơ bản về OpenMRS trong một số chương đầu tiên có thể được rút ngắn, người dùng có thể được chuyển đến trang OpenMRS.org để tìm hiểu thêm chi tiết. b. Chương Thiết lập nên được chuyển lên trước chương Quy trình phát triển
Cập nhật nội dung. Đối với tài liệu Bắt đầu làm nhà phát triển: a. Cập nhật môi trường được thiết lập cho Linux và Windows (Giới thiệu Docker) b. Cập nhật cấu hình IDE cho IntelliJ và Eclipse c. Liên kết tới Hướng dẫn cho nhà phát triển hoặc Hướng dẫn cho nhà phát triển nếu có. d. Đảm bảo tất cả nội dung của các đường liên kết đến đều là thông tin mới nhất.
Đối với Hướng dẫn sử dụng cho nhà phát triển: a. Giới thiệu quy trình phát triển. b. Giới thiệu cách tổ chức các nhóm phát triển, cách các thành viên trong nhóm làm việc cùng nhau; thêm đường liên kết vào cuộc họp nhóm, thảo luận nhóm; giúp nhà phát triển mới tìm thấy các nhóm mà họ có thể muốn tham gia. c. Thêm Docker vào chương thiết lập hệ thống. d. Thêm thông tin chi tiết về các loại mô-đun khác nhau (mô-đun ứng dụng tham chiếu, mô-đun OWA và mô-đun nền tảng), cách các mô-đun này hoạt động cùng nhau. e. Thêm mã ví dụ đơn giản để cho biết cách từng loại mô-đun được xây dựng và triển khai. f. Thêm các ví dụ kiểm thử đơn giản cho từng loại mô-đun.
Phân tích đối tượng
Đối tượng mục tiêu của hướng dẫn Bắt đầu làm nhà phát triển và Hướng dẫn cho nhà phát triển là các nhà phát triển có ít hoặc không có kiến thức về OpenMRS. Có thể có hai kiểu nhà phát triển: Loại đối tượng đầu tiên là các nhà phát triển trẻ có ít hoặc không có kinh nghiệm phát triển phần mềm. Ví dụ: những sinh viên của GSoC đang tìm kiếm các dự án thực tế để tìm hiểu về cách phát triển phần mềm nguồn mở. Đối với những nhà phát triển này, hai tài liệu này cần trình bày đầy đủ thông tin chi tiết và tài liệu tham khảo để họ có thể bắt đầu bổ sung kiến thức còn thiếu và bắt đầu đóng góp cho các dự án OpenMRS trong một khoảng thời gian tương đối ngắn. Mục tiêu chính dành cho các nhà phát triển tập sự là: 1. Nắm được các kỹ năng cần thiết để tham gia OpenMRS (MySQL, Java Spring. React.js, Git, v.v.) và tìm tài nguyên để học những kỹ năng này. 2. Tham gia cộng đồng OpenMRS và tìm hiểu các công cụ giao tiếp. 3. Thiết lập môi trường và IDE. 4. Cài đặt OpenMRS SDK. 5. Hiểu quy trình phát triển. 6. Tạo mã đơn giản để tạo mô-đun mới. 7. Triển khai các mô-đun mới tạo. 8. Mô-đun kiểm thử. 9. Sử dụng Git để đưa ra yêu cầu kéo. Loại đối tượng thứ hai là nhà phát triển trung cấp hoặc nhà phát triển cao cấp muốn tuỳ chỉnh OpenMRS cho phù hợp với nhu cầu của tổ chức của họ hoặc để đóng góp cho OpenMRS. Đối với những nhà phát triển có nhiều kinh nghiệm hơn này, hai tài liệu này phải cung cấp thông tin tổng quan về OpenMRS và đóng vai trò là hướng dẫn để hướng họ đến các thông tin chi tiết hơn về công nghệ trong Hướng dẫn cho nhà phát triển cũng như các tài nguyên khác. Mục tiêu chính của các nhà phát triển có kinh nghiệm là: 1. Tìm hiểu mô hình và cấu trúc dữ liệu của OpenMRS 2. Tham gia cộng đồng OpenMRS và tìm hiểu các công cụ giao tiếp. 3. Tìm đường liên kết đến kho lưu trữ mã OpenMRS. 4. Tìm thêm tài nguyên chuyên sâu.
Kế hoạch dự án
Giai đoạn lập kế hoạch: • Tinh chỉnh các mục tiêu đã đặt ra trong phần Phạm vi • Xác định những nội dung lỗi thời • Xây dựng bản thảo cho 2 tài liệu • Trình bày đề cương cho cố vấn và Chuyên gia về lĩnh vực (SME) • Cập nhật kế hoạch của dự án
Giai đoạn phát triển nội dung • Tìm hiểu Docker, thực hiện tất cả các bước cài đặt và tạo mã mẫu/mã thử nghiệm đơn giản • Phỏng vấn doanh nghiệp vừa và nhỏ để đặt câu hỏi • Phát triển bản thảo đầu tiên của hai tài liệu
Đánh giá và xuất bản nội dung • Tự chỉnh sửa nội dung • Gửi bản nháp hoàn chỉnh cho người đánh giá (người cố vấn và chuyên gia về lĩnh vực) và người dùng cuối để lấy ý kiến phản hồi • Chỉnh sửa bản nháp • Xuất bản hai tài liệu này trên trang OpenMRS wiki. • Viết báo cáo dự án
Công tác sơ bộ
Tôi đã hoàn thành một số công việc về môi trường phát triển được thiết lập trong hệ thống Linux và thiết lập SDK OpenMRS. Tôi đang trong quá trình định cấu hình IDE. Tôi sẽ tiếp tục xây dựng các mô-đun đơn giản và viết mã kiểm thử.
Tài liệu tham khảo và thảo luận
https://Talk.openmrs.org/t/Breaking-down-walls-and-attracting-more-devs-to-openmrs/28502/