หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- OpenMRS.org
- ผู้เขียนด้านเทคนิค:
- เอชมันทา
- ชื่อโปรเจ็กต์:
- การพัฒนาเอกสาร GithHub ที่เป็นมิตรกับผู้ใช้สำหรับ REST API
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์หลักของโครงการคือการพัฒนาเอกสารแบบอินเทอร์แอกทีฟที่ผู้ใช้ปลายทางสามารถโต้ตอบกับ API ด้วยตัวเลือกการทดลองใช้ได้ และในระหว่างนี้ควรใส่คำอธิบายที่สื่อความหมายและอธิบายด้วยตนเองมากขึ้น ซึ่งอธิบายให้บุคคลทั้งด้านเทคนิคและบุคคลที่ไม่ใช่ทางเทคนิคทราบว่าสถานการณ์ใดควรใช้ปลายทาง
สภาพแวดล้อมในปัจจุบันนี้ยอดเยี่ยมมาก แต่สำหรับผู้ที่ไม่เชี่ยวชาญด้านเทคโนโลยีหรือด้านเทคโนโลยียังคงยากต่อการหาไอเดียโดยตรงหากไม่มีเอกสารประกอบที่ถูกต้อง แนวคิดหลักคือการสร้างสภาพแวดล้อมและเอกสารประกอบที่มีชีวิตชีวานี้เอาไว้ในที่เดียวพร้อมกับการนำเสนอที่ดี ด้วยความช่วยเหลือจาก JS, HTML และ CSS