โปรเจ็กต์ OpenMRS

หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs

ข้อมูลสรุปของโปรเจ็กต์

องค์กรโอเพนซอร์ส:

OpenMRS

ผู้เขียนด้านเทคนิค:

สีรุ้ง

ชื่อโปรเจ็กต์:

การปรับปรุงเอกสารทางเทคนิคของ OpenMRS สำหรับนักพัฒนาแอปรายใหม่

ระยะเวลาของโปรเจ็กต์:

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

เหตุผล

ขณะที่ทั่วโลกกำลังเผชิญผลจากการแพร่ระบาดของโควิด-19 ยิ่งมีความชัดเจนว่าระบบเวชระเบียนแบบโอเพนซอร์สอย่าง OpenMRS จะเป็นส่วนหนึ่งของทางออกสำหรับวิกฤตประเภทนี้ได้ ในการช่วยนักพัฒนาซอฟต์แวร์รายใหม่ในการรับมือกับระบบนิเวศของ OpenMRS ทำให้ขั้นตอนการเริ่มต้นใช้งานสั้นลง และช่วยให้ผู้ใช้ใหม่เข้ามามีส่วนร่วมในการพัฒนา OpenMRS ได้รวดเร็วยิ่งขึ้น จึงจำเป็นต้องมีเอกสารประกอบที่กระชับ ชัดเจน และเป็นปัจจุบัน เอกสารสำหรับนักพัฒนาซอฟต์แวร์รายใหม่มีอยู่ 2 ฉบับด้วยกัน ดังนี้ • การเริ่มต้นใช้งานในฐานะนักพัฒนาซอฟต์แวร์ • คู่มือสำหรับนักพัฒนาซอฟต์แวร์ อย่างไรก็ตาม เนื้อหาบางส่วนล้าสมัยและต้องปรับปรุงรูปแบบ เป้าหมายของโครงการนี้คือการอัปเดตเนื้อหาและปรับปรุงรูปแบบของเอกสารทั้งสองนี้เพื่อให้ผู้ใช้เข้าใจได้ง่ายขึ้น

ขอบเขต

1. จัดระเบียบและจัดรูปแบบเนื้อหาของเอกสารทั้งสองใหม่ สำหรับเอกสาร "เริ่มต้นใช้งานในฐานะนักพัฒนาซอฟต์แวร์" ก. แบ่งขั้นตอนการสอน 17 ขั้นตอนออกเป็นส่วนต่างๆ โดยแต่ละส่วนจะมีขั้นตอนน้อยกว่านี้เพื่อให้ผู้ใช้ทำตามได้ง่ายขึ้น b. เรียงลำดับขั้นตอนใหม่ โดยบางขั้นตอนใช้รวมกันได้ ค. ใส่ลิงก์จากหน้า wiki อื่นๆ ในตาราง เพื่อให้วิธีการกระชับและอ่านได้ชัดเจนยิ่งขึ้น

สำหรับคู่มือสำหรับนักพัฒนาซอฟต์แวร์ ก. ข้อมูลเบื้องต้นของ OpenMRS ใน 2-3 บทแรกนั้นสามารถย่อลงได้ โดยผู้ใช้สามารถไปยังหน้า OpenMRS.org เพื่อดูรายละเอียดเพิ่มเติมได้ b. ควรย้ายบทการตั้งค่าไปอยู่ก่อนบทของกระบวนการพัฒนา

1. อัปเดตเนื้อหา สำหรับเอกสาร "เริ่มต้นใช้งานในฐานะนักพัฒนาซอฟต์แวร์" ก. อัปเดตสภาพแวดล้อมที่ตั้งค่าไว้สำหรับ Linux และ Windows (แนะนำ Docker) ข. อัปเดตการกำหนดค่า IDE สำหรับ IntelliJ และ Eclipse c. ลิงก์ไปยังคู่มือสำหรับนักพัฒนาซอฟต์แวร์หรือคู่มือนักพัฒนาซอฟต์แวร์ (หากมี) ง. ตรวจสอบว่าเนื้อหาที่ลิงก์ไปยังเนื้อหาทั้งหมดเป็นปัจจุบัน

   สำหรับคู่มือสำหรับนักพัฒนาซอฟต์แวร์ ก. แนะนำเวิร์กโฟลว์การพัฒนา ข. แนะนำวิธีจัดระเบียบทีมพัฒนา วิธีการทำงานร่วมกันของสมาชิกในทีม เพิ่มลิงก์ไปยังการประชุมของทีม การพูดคุยของทีม ช่วยให้นักพัฒนาซอฟต์แวร์รายใหม่ค้นหาทีมที่อาจต้องการเข้าร่วม ค. เพิ่ม Docker ในบทการตั้งค่าระบบ ง. เพิ่มรายละเอียดเกี่ยวกับโมดูลประเภทต่างๆ (โมดูลแอปพลิเคชันอ้างอิง, โมดูล OWA และโมดูลแพลตฟอร์ม) การทำงานร่วมกันอย่างไร จ. เพิ่มโค้ดตัวอย่างง่ายๆ เพื่อแสดงวิธีการสร้างและปรับใช้โมดูลแต่ละประเภท ฉ. เพิ่มตัวอย่างการทดสอบง่ายๆ สำหรับโมดูลแต่ละประเภท

การวิเคราะห์กลุ่มเป้าหมาย

กลุ่มเป้าหมายสำหรับการเริ่มต้นใช้งานในฐานะนักพัฒนาซอฟต์แวร์และคู่มือสำหรับนักพัฒนาซอฟต์แวร์คือนักพัฒนาซอฟต์แวร์ที่ไม่ค่อยหรือมีความรู้เกี่ยวกับ OpenMRS เพียงเล็กน้อย นักพัฒนาอาจมี 2 ประเภท ประเภทแรกคือกลุ่มเป้าหมายที่เป็นนักพัฒนาซอฟต์แวร์ระดับต้นๆ ที่มีประสบการณ์ในการพัฒนาซอฟต์แวร์น้อยหรือไม่มีเลย ตัวอย่างเช่น นักศึกษา GSoC ที่กำลังมองหาโครงงานจริงเพื่อเรียนรู้เกี่ยวกับการพัฒนาซอฟต์แวร์โอเพนซอร์ส สำหรับนักพัฒนาซอฟต์แวร์เหล่านี้ เอกสาร 2 ฉบับควรให้รายละเอียดและข้อมูลอ้างอิงที่เพียงพอเพื่อให้พวกเขาเริ่มต้นเติมเต็มช่องว่างทางความรู้และเริ่มมีส่วนร่วมกับโครงการ OpenMRS ได้ภายในระยะเวลาอันสั้น เป้าหมายหลักสำหรับบริษัทระดับจูเนียร์นักพัฒนาคือ 1. เข้าใจทักษะที่จำเป็นในการเข้าร่วม OpenMRS (MySQL, Java Spring React.js, Git ฯลฯ) และค้นหาแหล่งข้อมูลเพื่อเรียนรู้ทักษะเหล่านี้ 2. เข้าร่วมชุมชน OpenMRS เพื่อเรียนรู้เครื่องมือในการสื่อสาร 3. ตั้งค่าสภาพแวดล้อมและ IDE 4. ติดตั้ง OpenMRS SDK 5. เข้าใจเวิร์กโฟลว์การพัฒนา 6. สร้างโค้ดง่ายๆ เพื่อสร้างโมดูลใหม่ 7. ทำให้โมดูลที่สร้างขึ้นใหม่ใช้งานได้ 8. โมดูลทดสอบ 9. ใช้ Git เพื่อสร้างคำขอพุล กลุ่มเป้าหมายประเภทที่ 2 คือนักพัฒนาซอฟต์แวร์ระดับกลางหรือนักพัฒนาซอฟต์แวร์อาวุโสที่ต้องการปรับแต่ง OpenMRS ให้เหมาะกับความต้องการขององค์กรตนเองหรือสนับสนุน OpenMRS สำหรับนักพัฒนาซอฟต์แวร์มากประสบการณ์เหล่านี้ เอกสาร 2 ฉบับควรให้ภาพรวมของ OpenMRS และทำหน้าที่เป็นคู่มือที่นำไปยังรายละเอียดเทคโนโลยีที่เจาะลึกมากขึ้นในคู่มือนักพัฒนาซอฟต์แวร์และแหล่งข้อมูลอื่นๆ เป้าหมายหลักสำหรับนักพัฒนาซอฟต์แวร์ที่มีประสบการณ์มีดังนี้ 1. ทำความเข้าใจโมเดลข้อมูลและสถาปัตยกรรมของ OpenMRS 2. เข้าร่วมชุมชน OpenMRS เพื่อเรียนรู้เครื่องมือในการสื่อสาร 3. ค้นหาลิงก์ไปยังที่เก็บโค้ด OpenMRS 4. ค้นหาแหล่งข้อมูลในเชิงลึกเพิ่มเติม

แผนโครงการ

1. ระยะวางแผน • ปรับแต่งเป้าหมายที่ตั้งไว้ในส่วนขอบเขต • ระบุเนื้อหาที่ล้าสมัย • สร้างเค้าโครงสำหรับเอกสารทั้ง 2 ฉบับ • นำเสนอโครงร่างต่อที่ปรึกษาและผู้เชี่ยวชาญเฉพาะเรื่อง (SME) • อัปเดตแผนโครงการ

2. ระยะการพัฒนาเนื้อหา • เรียนรู้ Docker ทำตามขั้นตอนการติดตั้งทั้งหมด และสร้างตัวอย่างโค้ด/โค้ดการทดสอบแบบง่ายๆ • สัมภาษณ์ SME เพื่อถามคำถาม • สร้างฉบับร่างแรกของเอกสารทั้ง 2 รายการ

3. ตรวจสอบและเผยแพร่เนื้อหา • แก้ไขเนื้อหาด้วยตนเอง • ส่งฉบับร่างที่เสร็จสมบูรณ์แล้วให้ผู้ตรวจสอบ (ที่ปรึกษาและ SME) และผู้ใช้ปลายทางส่งความคิดเห็น • แก้ไขฉบับร่าง • เผยแพร่เอกสารทั้ง 2 รายการในหน้า OpenMRS wiki • เขียนรายงานโครงการ

งานเบื้องต้น

ฉันได้ดำเนินการตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ในการตั้งค่าระบบ 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.openmods.org/t/openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14