پروژه OpenMRS.org
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- OpenMRS.org
- نویسنده فنی:
- آیشمانتا
- نام پروژه:
- توسعه اسناد GithHub کاربر پسند برای REST API
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
هدف اولیه این پروژه ایجاد یک مستندات تعاملی است که در آن کاربران نهایی بتوانند با گزینه‌های آزمایشی با APIها تعامل داشته باشند و در عین حال توضیحات تشریحی و خود توضیحی بیشتری داشته باشند که به افراد فنی و غیر فنی توضیح دهد که در چه موقعیتی باید از نقطه پایانی استفاده کرد.
محیط swagger کنونی عالی است، اما برای افراد غیرتکنولوژیک و فن‌آور هنوز هم دریافت ایده مستقیم بدون مستندات مناسب دشوارتر است. ایده اصلی این است که این محیط و مستندات را در یک مکان با بازنمایی خوب جمع آوری کنید. با کمک JS، HTML و CSS.
محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است، مگر غیر از این ذکر شده باشد. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی."],[[["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"]]
