Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
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 dành 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 chịu hậu quả của đại dịch COVID-19, rõ ràng hơn nữa là một hệ thống bệnh án nguồn mở như OpenMRS có thể góp phần giải quyết 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 quy trình tham gia và tạo điều kiện cho nhiều thành viên mới có thể nhanh chóng đóng góp cho sự phát triển của OpenMRS, chúng tôi cần có các tài liệu ngắn gọn, rõ ràng và mới nhất. Hiện có hai tài liệu dành cho nhà phát triển mới: • Bắt đầu làm nhà phát triển • Hướng dẫn dành 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 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 để người dùng dễ sử dụng hơn.
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 là nhà phát triển: a. Chia 17 bước trong hướng dẫn thành các phần, mỗi phần chứa ít bước hơn để người dùng dễ dàng làm theo. b. Sắp xếp lại thứ tự các bước; một số bước có thể được kết hợp. c. Liệt kê các đường liên kết đến 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 Sách hướng dẫn dành cho nhà phát triển: a. Thông tin cơ bản về OpenMRS trong vài chương đầu có thể được rút ngắn, người dùng có thể được chuyển hướng đến trang OpenMRS.org để tìm hiểu thêm thông tin chi tiết. b. Bạn nên chuyển lên trước chương Quy trình phát triển chương Thiết lập
Cập nhật nội dung. Đối với tài liệu Bắt đầu với tư cách là nhà phát triển: a. Cập nhật chế độ thiết lập môi trường cho Linux và Windows (Giới thiệu Docker) b. Cập nhật cấu hình IDE cho IntelliJ và Eclipse c. Đường liên kết đến Hướng dẫn dành cho nhà phát triển hoặc Hướng dẫn dành cho nhà phát triển (nếu có). d. Đảm bảo rằng tất cả nội dung được liên kết đều được cập nhật.
Đối với Hướng dẫn 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 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 đến cuộc họp nhóm, cuộc thảo luận nhóm; giúp nhà phát triển mới tìm thấy nhóm mà họ 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 (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 thấy cách tạo và triển khai từng loại mô-đun. f. Thêm 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 tài liệu Bắt đầu với tư cách là nhà phát triển và Hướng dẫn dành cho nhà phát triển là những nhà phát triển có ít hoặc không có kiến thức về OpenMRS. Có thể có hai loại nhà phát triển: Loại đối tượng đầu tiên là các nhà phát triển mới có ít hoặc không có kinh nghiệm phát triển phần mềm. Ví dụ: học viên GSoC đang tìm kiếm các dự án thực tế để tìm hiểu về việc phát triển phần mềm nguồn mở. Đối với các nhà phát triển này, hai tài liệu này phải trình bày đầy đủ thông tin và tài liệu tham khảo để họ có thể 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. Các mục tiêu chính đối với nhà phát triển mới vào nghề là: 1. Hiểu 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, 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 SDK OpenMRS. 5. Tìm 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 để tạo yêu cầu kéo. Loại đối tượng thứ hai là các nhà phát triển cấp trung hoặc nhà phát triển cấp cao muốn tuỳ chỉnh OpenMRS cho phù hợp với nhu cầu của tổ chức hoặc để đóng góp cho OpenMRS. Đối với những nhà phát triển có kinh nghiệm hơn này, hai tài liệu này sẽ cung cấp thông tin tổng quan về OpenMRS và đóng vai trò là hướng dẫn để hướng họ đến thông tin chi tiết hơn về công nghệ trong Hướng dẫn dành cho nhà phát triển và các tài nguyên khác. Mục tiêu chính dành cho 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 được đặt trong phần Phạm vi • Xác định nội dung đã lỗi thời • Tạo dàn ý cho hai tài liệu • Trình bày dàn ý cho người cố vấn và Chuyên gia về chủ đề (SMEs) • Cập nhật kế hoạch 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ã ví dụ/mã kiểm thử đơn giản • Phỏng vấn các doanh nghiệp vừa và nhỏ để đặt câu hỏi • Phát triển bản nháp đầu tiên của hai tài liệu
Xem xét và xuất bản nội dung • Tự chỉnh sửa nội dung • Gửi bản nháp đã hoàn thành cho người đánh giá (người cố vấn và SMEs) và người dùng cuối để nhận ý kiến phản hồi • Sửa đổi bản nháp • Xuất bản hai tài liệu này trong trang wiki của OpenMRS. • Viết báo cáo dự án
Công việc sơ bộ
Tôi đã thực hiện 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 OpenMRS SDK. 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à nội dung thảo luận
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