בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- OpenMRS.org
- כותבים טכניים:
- Ayeshmantha
- שם הפרויקט:
- פיתוח מסמכי תיעוד ב-GithHub ל-API ל-REST שידידותיים למשתמשים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
המטרה העיקרית של הפרויקט היא לפתח תיעוד אינטראקטיבי שבו משתמשי הקצה יכולים ליצור אינטראקציה עם ממשקי ה-API עם אפשרויות להתנסות. בינתיים, לקבל תיאור תיאורי והסבר עצמי יותר שיסביר לאנשים הטכניים והלא טכניים באיזה מצב צריך להשתמש בנקודת הקצה.
סביבת ה-Swagger הנוכחית נהדרת, אבל גם לטכנאים וגם ללא טכנאים עדיין קשה לקבל מושג ישירות בלי תיעוד מתאים. הרעיון העיקרי הוא להציג את כל הסביבה והמסמכים של הראות במקום אחד כדי שיהיה ייצוג יפה. בעזרת JS, HTML ו-CSS.