این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- OpenMRS.org
- نویسنده فنی:
- آیشمانتا
- نام پروژه:
- توسعه اسناد GithHub کاربر پسند برای REST API
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
هدف اولیه این پروژه ایجاد یک مستندات تعاملی است که در آن کاربران نهایی بتوانند با گزینه‌های آزمایشی با APIها تعامل داشته باشند و در عین حال توضیحات تشریحی و خود توضیحی بیشتری داشته باشند که به افراد فنی و غیر فنی توضیح دهد که در چه موقعیتی باید از نقطه پایانی استفاده کرد.
محیط swagger کنونی عالی است، اما برای افراد غیرتکنولوژیک و فن‌آور هنوز هم دریافت ایده مستقیم بدون مستندات مناسب دشوارتر است. ایده اصلی این است که این محیط و مستندات را در یک مکان با بازنمایی خوب جمع آوری کنید. با کمک JS، HTML و CSS.