Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- OpenELIS Global
- Pisarz techniczny:
- Areesha
- Nazwa projektu:
- Dokumentacja OpenELIS dla użytkowników
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Chcemy zmienić wygląd i ulepszyć dokumentację OpenELIS przeznaczoną dla użytkowników. I-TECH ma zrewolucjonizować sposób, w jaki użytkownicy OpenELIS otrzymują pomoc w zależności od ich potrzeb w danym kontekście. Obecnie instrukcje korzystania z OpenELIS są zawarte w instrukcji obsługi, którą użytkownicy uznają za uciążliwe i czasochłonne. Niektórzy użytkownicy, zwłaszcza nowi, doceniają dostęp do szerokiej gamy materiałów, które mogą przeglądać i zdobywać w trakcie nauki. Inni użytkownicy, zwłaszcza ci bardziej doświadczeni i zaznajomieni z konkretnym produktem cyfrowym, takim jak OpenELIS, będą chcieli szybko znaleźć i użyć określonego zasobu, aby wypełnić formularz danych lub przesłać raport. Do takich działań należą:
przekształcenie istniejącej (nieaktualnej) instrukcji obsługi w kompleksową, aktualną bibliotekę pomocy zawodowych i pisemnych samouczków na temat wszystkich aktualnych funkcji (w tym nowszych funkcji, takich jak zarządzanie testami, skanowanie kodów kreskowych, wprowadzanie zbiorcze i importowanie wyników z narzędzia do indeksowania), w tym tagi metadanych pomagające w indeksowaniu informacji;
Opracowywanie i aktualizowanie angielskiej wersji materiałów pomocniczych
Udostępnianie użytkownikom listy „Top 10” z najczęściej używanymi materiałami pomocniczymi dotyczącymi pracy.
Tworzenie przewodnika po stylach i dokumentu z konwencjami kodowania