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