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:
- luzeal
- Nazwa projektu:
- Rejestracja w QubesOS Stwórzmy otwarty i łatwy w użyciu przewodnik
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Zacznij korzystać z QubesOS.
Chcę utworzyć przewodnik i powiązane materiały dla użytkowników, którzy po raz pierwszy korzystają z QubesOS. Celem byłoby przedstawienie QubesOS osobom nietechnicznym oraz stworzenie jak najbardziej zwięzłego i zrozumiałego przewodnika za pomocą analogii, ilustracji i diagramów. Aby zachować zwięzłość, użyjemy linków do wiarygodnych i zaufanych zasobów, w tym przede wszystkim do tych, które znajdują się na stronie QubesOS. Wszystko będzie udostępniane na licencji otwartej.
Przez „samodzielny” rozumiem materiał, który może istnieć niezależnie od witryny, na przykład jako podręcznik. Nie jest to równoznaczne z wersją przewodnika offline. W miarę możliwości wraz z witryną utworzymy dodatkowy potok publikowania treści w formie przewodnika.
Przez „otwarty” mam na myśli przewodnik, który zostanie opublikowany na zasadach otwartej licencji.
Jak można to zrobić
Określanie docelowych odbiorców
Obecnie mam wrażenie, że kategoria użytkowników, do których kieruje QubesOS, nie jest dobrze zdefiniowana. W jaki sposób QubesOS może pomóc dziennikarzom, prawnikom, analitykom bezpieczeństwa, deweloperom oprogramowania itp.? Warto opisać scenariusze, w których QubeOS może się przydać.
Określanie oczekiwań
Należy też ostrzec nowych użytkowników, że QubesOS wymaga pewnej wiedzy z zakresu IT. Korzystanie z QubesOS wiąże się z pewnymi kompromisami, zwłaszcza jeśli jest to Twój główny system operacyjny. Z drugiej strony, są też rzeczy, których QubesOS nie obsługuje (z założenia), takie jak akceleracja 3D w maszynach wirtualnych. Ważne jest, aby od razu wyraźnie zaznaczyć, że nie ma zniechęcać użytkowników do korzystania z niej, a jedynie określić wyłączenia dla potencjalnych użytkowników.
Co to jest QubesOS, a co nie
Mimo że QubesOS to specjalny system operacyjny (dystrybucja Xen), warto go porównać z innymi systemami operacyjnymi na podstawie ich funkcji lub ich braku (np. Windows coraz częściej wykorzystuje wirtualizację i sandboxing jako mechanizmy bezpieczeństwa). Można użyć prostego diagramu lub tabeli.
Specyfikacje przewodnika zostaną określone wspólnie ze społecznością.
Jakie informacje powinny się znaleźć w przewodniku? Jak bardzo można uprościć instalację bez poświęcania bezpieczeństwa? Gdzie powinien znajdować się próg? Czy istnieje minimalna konfiguracja QubesOS, która jest możliwa i bezpieczna? Jeśli nie, można go zdefiniować i ustawić jako cel przewodnika.
Licencja
Odbierz licencję. Szanowana strona Archlinux wiki używa GNU Free Documentation License w wersji 1.3 lub nowszej. Czy ta licencja będzie odpowiednia?
Inne przedsięwzięcia
Spraw, aby dokumentacja witryny była bardziej atrakcyjna wizualnie
Aby ułatwić ich zauważenie, notatki mogą być wyróżnione kolorem czerwonym lub żółtym. Można na przykład użyć kolorowych pól, takich jak te, które można znaleźć w wiki archlinux (https://wiki.archlinux.org/index.php/Linux_Containers).
Można użyć cytatów blokowych.
Zawartość linku
Witryna z dokumentacją zawiera obecnie sporo treści, ale poszczególne artykuły nie są często powiązane z innymi istotne tematy. Artykuły mogą być powiązane ze sobą, aby zwiększyć ich wykrywalność.