Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- OpenMRS.org
- Pisarz techniczny:
- Ayeshmantha
- Nazwa projektu:
- Tworzenie przyjaznej dla użytkownika dokumentacji GithHuba dla interfejsu API REST
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Głównym celem projektu jest opracowanie interaktywnej dokumentacji umożliwiającej użytkownikom wchodzenie w interakcję z interfejsami API za pomocą ich opcji testowania, a tymczasem udostępnienie bardziej opisowego i wyjaśnianego samodzielnie opisu, który wyjaśnia pracownikom technicznych i nietechnicznych, w jakich sytuacjach należy korzystać z punktu końcowego.
Obecne awangardowe środowisko jest świetne, ale nietechnikom i osobom z branży technologicznej trudniej jest wpaść na pomysł bez odpowiedniej dokumentacji. Głównym założeniem byłoby zgromadzanie tego eleganckiego środowiska i dobrze przedstawionej dokumentacji w jednym miejscu. Z pomocą JS, HTML i CSS.