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