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:
- Qubes OS
- Pisarz techniczny:
- c1e0
- Nazwa projektu:
- Przewodniki dotyczące rozwiązywania problemów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
ABSTRACT
Przewodnik po rozwiązywaniu problemów ma pomóc użytkownikom w rozwiązywaniu problemów, które występują podczas korzystania z produktu lub usługi. Dobry przewodnik po rozwiązywaniu problemów jest ważny, ponieważ pomaga użytkownikom w przypadku problemów. Dzięki temu użytkownicy nie rezygnują z używania produktu, gdy napotkają problem. Użytkownicy Qubes na całym świecie korzystają z niego codziennie, a wielu z nich w jakimś momencie napotka problem i będzie potrzebować przewodnika.
OBECNY STAN PRZEWODNIKA ROZWIĄZYWANIE PROBLEMÓW
Obecnie przewodniki dotyczące rozwiązywania problemów z QubesOS są rozproszone po wielu stronach i czasami są niekompletne, co powoduje, że użytkownicy muszą wielokrotnie czytać te same instrukcje, aby zdiagnozować problemy. Dostępne przewodniki nie zawierają układu „objawy – działanie”, co utrudnia użytkownikowi dopasowanie problemu do jego rozwiązania. Ponadto w mediach społecznościowych (Reddit), na stronie Qubes na GitHubie oraz na forum użytkowników Qubes pojawiły się pewne problemy, które nie zostały opisane w dotychczasowym przewodniku rozwiązywania problemów.
DLACZEGO PROPONOWANE PRZEZ NAS ROZWIĄZYWANIE PROBLEMÓW JEST LEPSZE OD OBECNEJ METODY?
Proponowany przeze mnie przewodnik rozwiązywania problemów będzie kompletny i uporządkowany, aby zapewnić dokładność i łatwość nawigacji. W przewodniku znajdziesz zwięzłe instrukcje, które krok po kroku wyjaśniają, jak rozwiązać problem. Będzie ona mieć układ symptom-działanie, w którym opisany zostanie problem, a następnie przedstawione zalecane rozwiązanie. Rozwiązania problemów będą zoptymalizowane pod kątem wyszukiwarek i sformułowane w taki sposób, aby uwzględniać problemy, których użytkownicy szukają w mediach społecznościowych i wyszukiwarkach. Dzięki wszystkim tym użytkownicy będą mogli znaleźć w wyszukiwarkach oficjalny przewodnik rozwiązywania problemów i szybko/łatwo znaleźć rozwiązanie
STRUKTURA PROPONOWANEGO PRZEWODNIKA USUWANIA PROBLEMÓW I OKRES PRZEGLĄDANIA
Utworzyliśmy proponowaną strukturę przewodnika rozwiązywania problemów z systemem operacyjnym Qubes. Znajdziesz go tutaj: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Do układu dołączono szacunkowy czas, w którym zostanie napisana każda sekcja rozwiązywania problemów. Ten układ zostanie wdrożony po otrzymaniu opinii mentora. Strukturę i ramy czasowe można zmodyfikować na podstawie opinii mentora.
CELE PROJEKTU
- Zmiana struktury przewodnika rozwiązywania problemów w celu utworzenia bardziej zrozumiałego, skonsolidowanego układu symptomów i działań.
- Przeredaguj istniejące rozwiązania problemów, aby otrzymywać proste i szczegółowe instrukcje.
- W razie potrzeby dodaj zrzuty ekranu
- Zainstaluj i wypróbuj Qubes i zapisz wszelkie napotkane problemy. Mam 3 komputery: Lenovo Thinkpad, Dell Latitude i Acer Aspire. Wypróbuję Qubes na każdym z tych komputerów, rejestrując wszelkie błędy i sprawdzając, czy problemy zostały rozwiązane.
- Usuń nieaktualne informacje z dotychczasowego przewodnika.
- Upewnij się, że informacje dotyczące rozwiązywania problemów są prawidłowe. Dotychczasowe przewodniki dotyczące rozwiązywania problemów zawierają komunikat o błędzie „To jest nieoficjalna dokumentacja firmy zewnętrznej. Projekt Qubes OS nie może zagwarantować dokładności tej strony. Zachowaj ostrożność”. To ostrzeżenie zostanie odrzucone, gdy instrukcje dotyczące rozwiązywania problemów zostaną zweryfikowane jako prawidłowe. Dokładność tych informacji zostanie zapewniona przez osobiste przetestowanie sposobów rozwiązywania problemów na moich komputerach (jeśli to możliwe) lub sprawdzenie online, czy jakieś osoby zweryfikowały rozwiązanie.
- Przeprowadź migrację wszystkich zewnętrznych rozwiązań problemów (z forum i GitHub) na oficjalną stronę rozwiązywania problemów.
- Przeprowadź badania i znajdź więcej problemów użytkowników na Reddit (r/QubesOS), Stack Exchange, w grupie Qubes-users w Google oraz na GitHubie. Będę też korzystać z narzędzi do analizy słów kluczowych, takich jak Keywordtool.io czy Ubersuggest.com, aby dowiedzieć się, jakie pytania są często wyszukiwane w wyszukiwarkach, takich jak Google.
- Dodaj sekcję „Uzyskiwanie pomocy”, jeśli przewodnik rozwiązywania problemów nie rozwiąże problemu użytkownika. Przykład można znaleźć na stronie rozwiązywania problemów z Fedorą: https://docs.fedoraproject.org/pl/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.
DLACZEGO TEN PROJEKT?
Interesuję się technologią, zwłaszcza bezpieczeństwem i prywatnością w internecie. Uważam, że pisanie jest jedną z moich mocnych stron. Jestem szczególnie zainteresowany systemem Qubes, ponieważ łączy on 2 ważne dla mnie kwestie: bezpieczeństwo i prywatność. Jestem aktywnym użytkownikiem innych usług skoncentrowanych na bezpieczeństwie i prywatności, takich jak DuckDuckGo i Tor. Odkryłem system Qubes dopiero niedawno i bardzo mi się podoba.
DLACZEGO WARTO MOGĘ UWIERZYĆ, ŻE JESTEM ODPOWIEDNIA OSOBĄ, KTÓREJ DOTYCZY TEGO PROJEKTU
- Interesują mnie bezpieczeństwo, prywatność i tworzenie przydatnej dokumentacji.
- Ponieważ miałem problemy z instalacją i korzystaniem z Qubes OS, będę w stanie lepiej przedstawić te problemy w instrukcjach rozwiązywania problemów.
- W ostatnim miesiącu studiowałem(am) techniczne aspekty systemu operacyjnego Qubes. Zapoznałem się też dokładnie z dokumentacją Qubes OS. Aby poznać proces edycji dokumentacji, utworzyłem prośbę o przeniesienie (https://github.com/QubesOS/qubes-doc/pull/1005/files).
- Niedawno odbyłem staż w projekcie Tor. Moje obowiązki obejmowały pomoc techniczną i tworzenie treści. Podczas pracy w centrum pomocy otrzymałem setki pytań od użytkowników, którzy mieli problemy z instalacją lub używaniem przeglądarki Tor. Podczas pomagania tym użytkownikom w rozwiązywaniu problemów nauczyłem się, jak pisać zwięzłe i zrozumiałe instrukcje dotyczące rozwiązywania problemów.
- Podczas pracy w Tor Project pisałam też dokumentację techniczną w Markdown. Do kontroli wersji używałem Git, GitHub i GitLab.