이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Qubes OS
- 기술 문서 작성자:
- c1e0
- 프로젝트 이름:
- 문제 해결 가이드 통합
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
추상
문제 해결 가이드는 최종 사용자가 제품 또는 서비스를 사용할 때 발생하는 문제를 해결할 수 있도록 설계되었습니다. 문제 해결 가이드가 중요한 이유는 문제가 발생할 때 사용자를 지원하기 때문입니다. 문제가 발생했을 때 사용자가 제품을 중단하지 않도록 합니다. Qubes는 전 세계에서 매일 수천 명의 사용자가 사용하고 있으며, 이 중 많은 사용자가 특정 시점에 문제를 겪게 되며 문제 해결 가이드의 도움을 받게 됩니다.
문제 해결 가이드의 현재 상태
현재 QubesOS 문제 해결 가이드는 여러 페이지에 흩어져 있고 불완전한 경우가 많아 사용자가 문제를 진단할 때 동일한 안내를 반복해서 게시하게 됩니다. 사용 가능한 가이드에는 증상 작업 레이아웃이 없으므로 사용자가 문제를 해결 방법과 일치시키기 어렵습니다. 또한 소셜 미디어 (Reddit), Qubes GitHub 문제 페이지, #qubes-users 포럼에 반복적으로 언급되었지만 현재 문제 해결 가이드에는 문서화되지 않은 문제도 있습니다.
제안된 문제 해결 가이드가 현재 가이드보다 나은 이유는 무엇인가요?
제가 제안한 문제 해결 가이드는 정확성과 쉬운 탐색을 위해 완전하고 체계적으로 구성되어 있습니다. 이 가이드에서는 문제를 단계별로 해결하는 방법을 설명하는 간결한 안내를 제공합니다. 문제를 설명하고 문제 해결을 위한 추천 해결책을 제시하는 증상 조치 레이아웃이 표시됩니다. 문제 해결은 검색엔진에 최적화되며 사용자가 소셜 미디어와 검색엔진에서 검색하는 문제를 고려하여 작성됩니다. 이를 통해 사용자는 검색엔진을 통해 공식 문제 해결 가이드를 찾고 문제의 해결 방법을 빠르고 쉽게 찾을 수 있습니다.
제안된 문제 해결 가이드 및 기간의 구조
Qubes OS 문제 해결 가이드의 제안된 구조를 만들었습니다. 여기(https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing)에서 확인할 수 있습니다. 레이아웃에는 각 문제 해결 섹션이 작성될 예상 기간이 함께 표시됩니다. 이 레이아웃은 멘토의 의견을 받은 후에 구현됩니다. 구조와 기간은 멘토의 의견에 따라 변경될 수 있습니다.
프로젝트 목표
- 더 이해하기 쉬운 통합된 증상-조치 레이아웃을 갖도록 문제 해결 가이드를 재구성했습니다.
- 따라하기 쉬운 단계별 안내가 포함되도록 기존 문제 해결을 다시 작성합니다.
- 필요한 경우 스크린샷 추가
- Qubes를 직접 설치하고 사용해 보고 발생한 문제를 기록합니다. Lenovo Thinkpad, Dell Latitude, Acer Aspire 등 3대의 컴퓨터를 사용하고 있습니다. 각 컴퓨터에서 Qubes를 사용해 보고 오류를 기록하고 문제 해결을 확인해 보겠습니다.
- 기존 가이드에서 오래된 정보를 삭제합니다.
- 문제 해결 단계가 정확한지 확인합니다. 현재 기존 문제 해결 가이드에는 '이 문서는 비공식적인 서드 파티 문서입니다. Qubes OS 프로젝트는 이 페이지의 정확성을 보증할 수 없습니다. 주의하세요."" 문제 해결 안내가 정확한 것으로 확인되면 이 경고는 삭제됩니다. PC에서 직접 문제 해결 단계를 테스트하거나 (가능한 경우) 온라인에서 다른 사용자가 솔루션을 확인했는지 확인하여 정확성을 보장합니다.
- 포럼 및 GitHub의 외부 문제 해결 단계를 공식 문제 해결 웹페이지로 이전합니다.
- Reddit (r/QubesOS), Stack Exchange, #qubes-users Google 그룹, GitHub 문제 등 사용자가 직면한 문제를 조사하고 찾아보세요. 또한 Keywordtool.io 및 UberSuggest.com과 같은 키워드 조사 도구를 사용하여 Google과 같은 검색엔진에서 자주 검색되는 질문을 파악합니다.
- 문제 해결 가이드로 사용자의 문제가 해결되지 않는 경우 '도움말 확인' 섹션을 추가합니다. Fedora의 문제 해결 페이지(https://docs.fedoraproject.org/ko-KR/fedora/rawhide/install-guide/install/troubleshooting/#sect-troubleshooting-getting-help)에서 예를 확인할 수 있습니다.
이 프로젝트를 진행하는 이유
기술, 특히 사이버 보안과 개인 정보 보호에 관심이 많습니다. 저는 글쓰기가 저의 가장 큰 장점이라고 생각합니다. Qubes OS는 보안과 개인 정보 보호라는 두 가지 주요 관심분야가 교차하는 부분이므로 특히 관심이 갑니다. 저는 DuckDuckGo 및 Tor와 같은 다른 보안 및 개인 정보 보호 중심 제품을 애용합니다. 저는 최근에 Qubes OS를 알게 되었으며 지금까지 매우 만족하고 있습니다.
이 프로젝트에 적합한 이유
- 보안과 개인 정보 보호에 열정을 갖고 있으며 유용하고 도움이 되는 문서를 작성합니다.
- Qubes OS를 설치하고 사용할 때 문제가 발생했기 때문에 문제 해결 안내에서 이러한 문제를 더 잘 설명할 수 있을 것입니다.
- 지난 한 달 동안 Qubes 운영체제의 기술적 측면을 연구했습니다. Qubes OS 문서도 광범위하게 살펴봤습니다. 문서 수정 절차를 파악하기 위해 풀 요청 (https://github.com/QubesOS/qubes-doc/pull/1005/files)을 작성했습니다.
- 최근에 Tor 프로젝트에서 인턴십을 마쳤습니다. 기술 지원 및 작성 업무를 담당했습니다. 헬프데스크에서 근무하는 동안 Tor 브라우저를 설치하거나 사용할 때 문제가 발생한 사용자로부터 수백 건의 질문을 받았습니다. 이러한 사용자의 문제를 해결하면서 간결하고 이해하기 쉬운 문제 해결 안내를 작성하는 방법을 배웠습니다.
- Tor 프로젝트에서 근무하는 동안 마크다운을 사용하여 기술 문서를 작성하기도 했습니다. 버전 제어를 위해 Git, GitHub, GitLab을 사용했습니다.