โปรเจ็กต์ OpenMRS.org
หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- OpenMRS.org
- นักเขียนเชิงเทคนิค
- Ayeshmantha
- ชื่อโปรเจ็กต์:
- การพัฒนาเอกสารประกอบ GithHub ที่ใช้งานง่ายสําหรับ REST API
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์หลักของโปรเจ็กต์นี้คือการพัฒนาเอกสารประกอบแบบอินเทอร์แอกทีฟที่ผู้ใช้ปลายทางสามารถโต้ตอบกับ API ด้วยตัวเลือกการลองใช้ และในระหว่างนี้จะมีคำอธิบายที่สื่อความหมายและอธิบายด้วยตนเองมากขึ้น ซึ่งจะอธิบายให้ผู้ที่เชี่ยวชาญด้านเทคนิคและผู้ที่เชี่ยวชาญด้านเทคนิคทราบถึงสถานการณ์ที่ควรใช้ปลายทาง
สภาพแวดล้อม Swagger ปัจจุบันนั้นยอดเยี่ยม แต่สำหรับผู้ที่ไม่เชี่ยวชาญด้านเทคโนโลยีและผู้ที่เชี่ยวชาญด้านเทคโนโลยีก็ยังคงเข้าใจแนวคิดได้ยากขึ้นหากไม่มีเอกสารประกอบที่เหมาะสม แนวคิดหลักคือการรวมสภาพแวดล้อมและเอกสารประกอบของ Swagger ไว้ในที่เดียวพร้อมการแสดงผลที่สวยงาม ด้วยความช่วยเหลือของ JS, HTML และ CSS
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2024-11-08 UTC
[null,null,["อัปเดตล่าสุด 2024-11-08 UTC"],[[["The project aims to create user-friendly GitHub documentation for OpenMRS's REST API, making it accessible to both technical and non-technical users."],["It involves developing interactive documentation with \"try-out\" options and clear descriptions of API use cases, enhancing the existing Swagger environment."],["This 3-month Google Season of Docs project will utilize JS, HTML, and CSS to improve the accessibility and understanding of the OpenMRS REST API."]]],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"]]
