Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Otwarta kolekcja
- Pisarz techniczny:
- Anna e só
- Nazwa projektu:
- Ulepsz ogólną dokumentację pomocy
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Pierwsze wrażenia Często zdarza się, że strony z dokumentacją zawierają instrukcje bez odpowiednich multimediów (filmy, GIF-y, obrazy), podczas gdy inne sekcje tego samego rozdziału mają bardziej pełne wpisy – na przykład sekcja Edytuj zbiorczo składa się tylko z instrukcji, a Dodaj host fiskalny zawiera dodatkowe multimedia.
Na przeglądanych stronach nie ma opisu żadnych multimediów za pomocą atrybutu tekst alternatywny. Dla osób korzystających z czytników ekranu oraz osób z wolniejszym połączeniem internetowym, gdzie multimedia mogą się nie wczytać, brak opisów obrazów uniemożliwia pełne zrozumienie dokumentacji.
W niektórych sekcjach dokumentacji scalono najczęstsze pytania i bezpośrednie instrukcje poruszania się po interfejsie, na przykład Zmiana hosta fiskalnego. Ponieważ w interfejsie dokumentacji nie ma spisu treści, użytkownik, który zdaje sobie sprawę z konsekwencji zmiany w rekordach rejestracji i potrzebuje tylko obiektywnych instrukcji, może uznać dokumentację za wyczerpującą i zbyt styczną.
Chociaż język dokumentacji technicznej jest dosyć spójny, publicznie dostępny Przewodnik po stylu nie zawiera zbyt wielu informacji na temat tego, jak należy pisać dokumentację. Strona Współtwórcy zawiera wzmianki o wkładach w dokumentację techniczną, dlatego bardziej kompleksowe wytyczne przydałyby się zarówno zespołowi Open Collective, jak i potencjalnym współtwórcom.
Propozycja Proponuję przegląd stron pomocy dla użytkowników i przemyślenie ich prezentacji oraz obecnej struktury.
Metodologia i harmonogram Chcę ulepszyć dokumentację Open Collective, współpracując ze społecznością, promując cykle ciągłego przekazywania opinii o różnym czasie trwania.
Okres integrowania społeczności (1 sierpnia – 1 września 2019 r.): poznaj społeczność Open Collective Przeprowadzanie wywiadów z aktywnymi uczestnikami pracującymi w najważniejszych i początkujących projektach i zadawanie im pytań o bieżący stan dokumentacji (Raport 1). Zwróć uwagę na wszystkie systemy wewnętrzne używane do śledzenia zapytań i problemów oraz na proces ich dokumentowania w Dokumentach Open Collective (Raport 2). Ocena ukrytych problemów w bieżącej wersji dokumentacji oraz opracowanie planu ich rozwiązania (Raport 3).
2–6 września: pierwsza opinia i cykl dostosowania, z uwzględnieniem wszystkich komentarzy i sugestii społeczności w okresie budowania więzi ze społecznością. Czy możemy kontynuować? Czy jest coś, co trzeba zmienić? (Raport 4)
9–20 września: opracowanie modelu koncepcyjnego z mniej zapełnionym rozdziałem w dokumentacji. Wersja robocza publicznego Przewodnika stylistycznego (raport nr 5).
23–25 września: przesłanie modelu koncepcyjnego do oceny (grupa zamknięta).
26–27 września: czy model koncepcyjny wymaga poprawek przed opublikowaniem? Czy potrzebujemy więcej czasu? Dostosuj je odpowiednio. (Raport 6)
30 września – 9 października: udostępnienie modelu koncepcyjnego. Drugi cykl przesyłania opinii (grupa publiczna).
10–15 października: ostatni etap oceny koncepcji i cyklu dostosowywania. (Raport 7)
16–20 października: krótka przerwa od aktywności [1].
21 października–23 listopada: ostateczna wersja Przewodnika po stylu publicznym (raport nr 8). Stosowanie wszystkich instrukcji zawartych w przewodniku stylów do wszystkich stron dokumentacji użytkownika (raport nr 9). Raport zawierający ocenę wszystkich wykonanych działań i dalsze rekomendacje dla społeczności (raport nr 10).
Czas trwania projektu może zostać wydłużony na żądanie.
[1]: Podróż zaplanowana przed przesłaniem aplikacji Sezon Dokumentów.
Materiały dla wszystkich