โปรเจ็กต์ OpenMRS

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

สรุปโปรเจ็กต์

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

OpenMRS

นักเขียนเชิงเทคนิค

สีรุ้ง

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

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

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

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

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

เหตุผล

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

ขอบเขต

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

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

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

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

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

กลุ่มเป้าหมายของ "การเริ่มต้นใช้งานในฐานะนักพัฒนาซอฟต์แวร์" และ "คู่มือนักพัฒนาซอฟต์แวร์" คือนักพัฒนาซอฟต์แวร์ที่มีความรู้เกี่ยวกับ OpenMRS เพียงเล็กน้อยหรือไม่มีความรู้เลย นักพัฒนาซอฟต์แวร์อาจแบ่งออกเป็น 2 ประเภท ได้แก่ กลุ่มเป้าหมายประเภทที่ 1 คือนักพัฒนาซอฟต์แวร์ระดับเริ่มต้นที่มีประสบการณ์ด้านการพัฒนาซอฟต์แวร์เพียงเล็กน้อยหรือไม่มีเลย ตัวอย่างเช่น นักเรียน 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 ฉบับ • นำเสนอเค้าโครงต่อที่ปรึกษาและผู้เชี่ยวชาญด้านเนื้อหา (SMEs) • อัปเดตแผนโปรเจ็กต์

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

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