Projekt Qubes OS
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
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.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-07-25 UTC."],[[["\u003cp\u003eThis project aims to consolidate and improve the Qubes OS troubleshooting guides, offering users a more comprehensible and user-friendly experience.\u003c/p\u003e\n"],["\u003cp\u003eThe current troubleshooting guides are scattered, incomplete, and lack a clear structure, making it difficult for users to find solutions.\u003c/p\u003e\n"],["\u003cp\u003eThe proposed guide will feature a symptom-action layout, step-by-step instructions, and cover a wider range of issues based on user feedback and research.\u003c/p\u003e\n"],["\u003cp\u003eThe project will be undertaken by a technical writer with experience in cybersecurity, privacy, and technical documentation, including a recent internship at the Tor Project.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to create a centralized, accurate, and easily navigable troubleshooting resource for Qubes OS users, enhancing the overall user experience.\u003c/p\u003e\n"]]],["The project aims to overhaul the Qubes OS troubleshooting guide for the Google Season of Docs. Key actions include restructuring the guide with a symptom-action layout, rewriting existing content into step-by-step instructions, adding screenshots, and removing outdated information. The technical writer will install Qubes on multiple devices to find and document issues. External troubleshooting content will be migrated, and user-reported problems on social media will be researched. Finally, a \"Getting help\" section will be added.\n"],null,["# Qubes OS project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: Qubes OS\n\nTechnical writer:\n: c1e0\n\nProject name:\n: Consolidate troubleshooting guides\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\n#### ABSTRACT\n\nA troubleshooting guide is designed to help end-users solve any problems encountered when using a product or service. A good troubleshooting guide is important because it assists users when problems arise. It keeps users from abandoning a product when they encounter an issue. Qubes has thousands of daily users around the world, many of whom will face an issue at some point in time and will benefit from a troubleshooting guide.\n\n#### CURRENT STATE OF THE TROUBLESHOOTING GUIDE\n\nAt this moment, the QubesOS troubleshooting guides are scattered across many pages and sometimes incomplete, leading to repeatedly posting the same instruction over and over when helping users to diagnose problems. The available guides lack a symptom-action layout, making it difficult for a user to match a problem to its solution. In addition, there are some issues that have been mentioned repeatedly on social media (Reddit), the Qubes Github issues page and on the #qubes-users forum, but have not been documented on the current troubleshooting guide.\n\n#### WHY IS MY PROPOSED TROUBLESHOOTING GUIDE AN IMPROVEMENT OVER THE CURRENT ONE?\n\nMy proposed troubleshooting guide will be complete and structured to ensure accuracy and easy navigation. The guide will showcase concise instructions that explain how to solve a problem in a step-by-step manner. It will feature a symptom-action layout, where a problem will be stated, followed by a recommended solution to solving that problem.\nThe troubleshoots will be search-engine optimized and worded to take into account what problems users are searching on social media and search engines. All these will go to ensure that users can find the official troubleshooting guide through search engines and quickly/easily find the solution to their problems\n\n#### STRUCTURE OF THE PROPOSED TROUBLESHOOTING GUIDE and TIMEFRAME\n\nI have created a proposed structure for the Qubes OS troubleshooting guide which can be found here: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. The layout is accompanied by an estimated timeframe during which each troubleshoot section will be written. This layout will be implemented after feedback from the mentor. The structure and timeframe may be modified based on mentor feedback.\n\n#### PROJECT GOALS\n\n- Restructure the troubleshooting guide to have a more comprehensible, consolidated symptom-action layout.\n- Rewrite existing troubleshoots to have easy-to-follow step-by-step instructions.\n- Add screenshots where necessary\n- Install and try out Qubes myself and record any problems encountered. I have three computers: a Lenovo Thinkpad, Dell Latitude, and an Acer Aspire. I will try Qubes on each of these computers, recording any errors and validating any troubleshoots.\n- Remove any obsolete information in the existing guide.\n- Ensure the troubleshoots are accurate. As of now, the existing troubleshooting guides have the error message \"\"This is unofficial, third-party documentation. The Qubes OS Project cannot guarantee the accuracy of this page. Please exercise caution\"\". This warning will be discarded after the troubleshooting instructions are verified to be accurate. Their accuracy will be ensured by either personally testing the troubleshoots on my PCs (if possible), or checking online if any users have validated the solution.\n- Migrate any external troubleshoots (from the forum and GitHub) to the official troubleshooting webpage.\n- Research and find more troubles faced by users from Reddit (r/QubesOS), Stack Exchange, #qubes-users Google group, and GitHub issues. I will also use keyword research tools like Keywordtool.io and UberSuggest.com to discover what questions are frequently searched on search engines like Google.\n- Add a \"Getting help\" section, in case the troubleshooting guide doesn't solve the users' problem. An example can be seen in Fedora's troubleshooting page: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.\n\n#### WHY THIS PROJECT?\n\nI am passionate about technology, particularly cybersecurity and privacy. I believe writing is one of my strongest suits. I'm particularly interested in the Qubes OS because it intersects two major interests of mine: security and privacy. I am an avid user of other security and privacy-focused products like DuckDuckGo and Tor. I only recently discovered Qubes OS, and I am loving it so far.\n\n#### WHY I BELIEVE I AM THE RIGHT PERSON FOR THIS PROJECT\n\n- I am passionate about security, privacy, and writing good/helpful documentation.\n- Because I have experienced issues when installing and using Qubes OS, I will be able to better represent these issues in the troubleshooting instructions.\n- In the past month, I've studied the technical aspects of the Qubes Operating System. I have also studied the Qubes OS documentation extensively. To get a feel of the documentation-editing process, I created a pull request (https://github.com/QubesOS/qubes-doc/pull/1005/files)\n- I recently completed an internship at the Tor project. My roles were technical support and writing. While working at the helpdesk, I received hundreds of questions from users who faced troubles when installing or using Tor Browser. By helping these users troubleshoot their problems, I learned how to write concise and comprehensible troubleshooting instructions\n- While working at the Tor Project, I also wrote technical documentation using Markdown. I used Git, GitHub, and GitLab for version control."]]
