Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie 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 interakcję z interfejsami API, korzystając z wypróbowanych opcji, a tymczasem udostępnienie bardziej opisowego i wyjaśnionego samodzielnie opisu z opisem osób technicznych i nietechnicznych w sytuacji, w której należy użyć punktu końcowego.
Obecne środowiskowa jest świetne, ale dla niepełnosprawnych użytkowników technologii i technologii nadal trudniej jest znaleźć pomysł bezpośrednio bez odpowiedniej dokumentacji. Głównym założeniem byłoby zgromadzanie tego luźnego środowiska i dobrze przedstawianej dokumentacji w jednym miejscu. Z pomocą JS, HTML i CSS.