Ta strona została przetłumaczona przez Cloud Translation API.

Projekt VLC

Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.

Podsumowanie projektu

Organizacja open source:: VLC
Pisarz techniczny:: Avii
Nazwa projektu:: Utwórz dokumentację użytkownika VLC dla jednego portu mobilnego (Android).
Długość projektu:: Standardowa długość (3 miesiące)

Opis projektu

Streszczenie

Dokumentacja użytkownika jest używana jako statyczny system wsparcia dla użytkowników. Zawierają zarówno informacje techniczne, jak i inne niż te, które są związane z produktem lub usługą. Pomaga użytkownikom nauczyć się korzystać z oprogramowania lub usług. Nie każdy chce kontaktować się z zespołem pomocy lub czekać na e-maila z odpowiedzią. Może się okazać, że wystarczy wskazówka, porady lub wskazówki. Tak wygląda dokumentacja użytkownika. Obniżają też koszty pomocy i pozwalają decydować o prawidłowym działaniu usługi oraz pracy zespołu programistów.

Aplikacja VLC na Androida została pobrana ponad 100 milionów razy ze Sklepu Google Play. VLC oferuje szereg funkcji dla portów mobilnych, od odtwarzania dźwięku i wideo po strumień sieciowy. Ludzie często chcą korzystać z tych wspaniałych funkcji, ale nie są w stanie tego zrobić. Wyszukiwanie bloga lub filmu wideo wymaga dużo czasu i cierpliwości, a mimo to uzyskane informacje nie są autentyczne. Obecnie VLC hostuje dokumentację użytkownika VLC na Androida na stronie wiki i nie udostępnia opisów tych funkcji lub udostępnia ich mniej. Ponadto w marcu 2019 r. zaktualizowaliśmy strony wiki. Obecny projekt udostępni nową dokumentację dla użytkowników o nowoczesnym wyglądzie i łatwiej będzie obsługiwać port Androida.

OBECNA SYTUACJA

Strony wiki są całkowicie nieaktualne i zawierają bardzo mało informacji o najnowszej wersji VLC. Ponadto nie jest ona łatwa w nawigacji. Nie ma opcji pozwalającej przeczytać dokumentację w języku innym niż angielski. Nie zawiera on opisów cech.

ANALIZA

-> Obecnie obecna dokumentacja jest nieaktualna i musi zostać napisana w nowy sposób oraz z wykorzystaniem innej platformy i narzędzi.

-> Większość użytkowników Androida ma niewielką wiedzę techniczną lub nie ma jej wcale. Są jednak osoby, które potrzebują bardziej technicznych informacji o danej funkcji. Napisanie i utworzenie 2 osobnych dokumentów do każdego z powyższych celów nie jest dobrym pomysłem. Nawet w tej samej dokumentacji podzielenie funkcji na podstawie kwestii technicznych i nietechnicznych tworzy dodatkowe niejasności. Jak widać, większość użytkowników jest przyzwyczajona do interfejsu i funkcji, z których korzysta, więc nie każdy może łatwo zdecydować, czy chodzi o dane techniczne, czy też o mniej techniczne. Chcemy ułatwić im korzystanie z tej funkcji.

-> Większość użytkowników próbuje uzyskać informacje za pomocą smartfona, a odpoczywać na komputerze lub innym urządzeniu. Dokumentacja powinna być więc łatwa do dostosowania do każdego rozmiaru ekranu. oraz nie powinny powodować nieporozumień w nawigacji.

-> Nie wszystkie funkcje wersji komputerowej są dostępne na porcie Androida i, jeśli są dostępne, nie działają tak samo na obu portach. Wynika to z faktu, że aplikacje na komputery są opracowywane od dłuższego czasu i osiągnęły już stopień nasycenia, natomiast port komórkowy jest stosunkowo nowy i wciąż się rozwija. Co więcej, chociaż dzisiaj urządzenia mobilne stają się bardzo przydatne, to jednak istnieją oczywiste ograniczenia dotyczące typów funkcji, które możemy uwzględnić głównie ze względu na zapotrzebowanie ze strony użytkowników. Brak możliwości korzystania z funkcji to strata zasobów deweloperskich. Nie zalecamy więc konwertowania obu dokumentów na podstawie funkcji.

NA PODSTAWIE POWYŻSZEJ ANALIZY PROPONOWAMY NASTĘPUJĄCE INFORMACJE. 1. W tej chwili dokumentacja użytkowników komputerów korzysta z generatora dokumentacji Sphinx i do odczytu motywu Dokumentów. Ten sam sposób używania portu w Androidzie ułatwi nam: -> Łatwe scalenie obu dokumentów. -> Jest zoptymalizowana pod kątem wszystkich rozmiarów ekranu. -> Sprawne przechodzenie do dokumentacji użytkownika Androida z poziomu Dokumentacji na komputerze.

Rozdzielenie rozdziałów, sekcji i podsekcji według ich względnego położenia w aplikacji. Na przykład: tryb Tło/PiP znajduje się w obszarze Więcej -> Ustawienia -> Wideo, więc struktura rozdziałów będzie miała postać

Więcej

|__Ustawienia

| |__Biblioteka multimediów

| |__Video --> Tło/tryb PIP

: -> To podejście ułatwi dostęp, ponieważ użytkownicy będą mogli z łatwością przejść do części, w której potrzebują pomocy, porównając ją ze względnej lokalizacji w aplikacji. Możemy podzielić kolejne funkcje na poszczególne funkcje techniczne od tych, które nie są techniczne. Najpierw napiszemy prosty opis, który nie jest techniczny, a następnie podświetlimy lub oznakujemy techniczne części tego samego obiektu, jeśli takie występują. Może to spowodować pewne powtórzenia, ale zapewni bezproblemową obsługę większości osób, które nie posługują się umiejętnościami technicznymi. Pomoże to również w przyszłości, poprawiając łatwość obsługi. Gdy aplikacja osiągnie stan nasycenia, względny interfejs użytkownika prawdopodobnie nie zmieni się znacząco. Jeśli w przyszłości zostanie dodana lub usunięta nowa funkcja, możemy po prostu zmodernizować tę sekcję. Jeśli cały interfejs użytkownika uległ zmianie, możemy rozmieścić sekcje/rozdziały lub zmienić strukturę całego dokumentu. W obu przypadkach musimy zmodyfikować całą dokumentację, ponieważ zrzut ekranu musi zostać zastąpiony, aby pasował do bieżącego interfejsu. Tutaj znajdziesz działającą wersję demonstracyjną : https://avinal.gitlab.io/vlc-android-docs/
.
Każda sekcja dokumentacji powinna zawierać oznaczony zrzut ekranu , opis funkcji, część techniczną (w razie potrzeby) oraz wskazówki i porady dotyczące funkcji.

-> Niezależnie od opracowania tej dokumentacji dla użytkowników na komputerze, ułatwisz nam scalenie obu dokumentów w kilku krokach. Nie wpłynie to na obecną dokumentację ani nie wpłynie na nią w trakcie tworzenia aplikacji. Proponuję umieścić całą tę dokumentację w sekcji dotyczącej Androida po jej opracowaniu, a następnie utworzyć link bezpośredni do dokumentacji VLC dla Androida.

-> Więcej ulepszeń może obejmować przeprojektowanie strony startowej w dokumentacji dla użytkowników komputerów, co umożliwia bezpośredni wybór ulubionego systemu operacyjnego i przekierowanie do jego dokumentacji. Dokumentacja użytkownika VLC w systemach Windows, macOS i Linux jest już dobrze przygotowana i skorelowana, dlatego możemy dodać opcje do wyboru: Windows/MacOS/Linux lub Android lub iOS. Spowoduje to utworzenie dobrze oddzielonej, ale ujednoliconej dokumentacji użytkownika, zawierającej tylko 1 link do wykorzystania we wszystkich portach.

DLACZEGO MOJA PROPONOWANA DOKUMENTACJA UŻYTKOWNIKÓW JEST LEPSZA? Proponowana dokumentacja dla użytkowników została opracowana w oparciu o typowe wzorce stosowane przez użytkowników w celu uzyskania pomocy. Dokumentacja łączy wszystkie wymagane funkcje, takie jak prostota, przejrzystość, wygląd i styl, wiedza technologiczna, aby zmaksymalizować łatwość obsługi i wygodę użytkowników. Łatwość obsługi jest też łatwa w obsłudze, ponieważ nie trzeba już tworzyć dokumentacji poszczególnych użytkowników dla każdego portu.

DLACZEGO JESTEM ODPOWIEDNIĄ OSOBĄ DO TEGO PROJEKTU? -> Piszę kod od 2 lat i często muszę przejrzeć dokumentację API niektórych bibliotek lub wybranego oprogramowania, a nawet udokumentować własny kod. Wiem więc dokładnie, czego oczekują odbiorcy w dokumentacji, z jakimi problemami mają do czynienia i w jaki sposób korzystają z pomocy. Mogę wykorzystać te same funkcje, aby stworzyć spójną i czytelną dokumentację.

-> Aktywnie piszę prace techniczne na platformach Quora, Stack Overflow i na różnych innych platformach. Wiem, jak wyjaśniać różne rzeczy w chwytliwy i zrozumiały sposób.

-> VLC na Androida to zaawansowane i bardzo znane narzędzie, ale większość jego funkcji jest nieznana lub nie ma pomocy. Od wielu lat korzystam z VLC zarówno na komputerach, jak i na urządzeniach mobilnych, i wiem, jakie problemy mogą napotkać użytkownicy. Wykorzystując swoją wiedzę i doświadczenie, możemy zapewnić doskonałą dokumentację.