Ta strona zawiera szczegóły projektu przygotowywania tekstów technicznych przyjętego do programu Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Qubes OS
- Pisarz techniczny:
- luzeal
- Nazwa projektu:
- Wprowadzenie do QubesOS Napiszmy otwarty i łatwy w użyciu przewodnik
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Wprowadzenie do QubesOS
Chcę utworzyć otwarty przewodnik i powiązane materiały dla osób, które po raz pierwszy korzystają z QubesOS. Celem jest przedstawienie QubesOS osobom, które nie mają wiedzy technicznej, oraz napisanie przewodnika w sposób jak najbardziej zwięzły i zrozumiały, z użyciem analogii, ilustracji i diagramów. Aby zachować zwięzłość, będę używać linków do wiarygodnych i zaufanych źródeł, w tym przede wszystkim do tych, które znajdują się w witrynie QubesOS. Wszystkie materiały zostaną udostępnione na licencji open source.
Przez „samodzielny” rozumiem treści, które mogą istnieć niezależnie od witryny, np. jako podręcznik. Nie jest to równoznaczne z wersją przewodnika offline. Najlepiej byłoby utworzyć dodatkowy potok publikowania treści jako przewodnika obok witryny.
Przez „otwarty” rozumiem przewodnik, który zostanie udostępniony na licencji open source.
Jak to zrobić
Określenie docelowych odbiorców
Obecnie mam wrażenie, że kategoria użytkowników, do których kierowany jest system QubesOS, nie jest dobrze zdefiniowana. Jak QubesOS może pomóc dziennikarzom, prawnikom, analitykom ds. bezpieczeństwa, programistom itp.? Warto byłoby opisać scenariusze, w których QubesOS może się przydać.
Określenie oczekiwań
Ważne byłoby też ostrzeżenie użytkowników, którzy po raz pierwszy korzystają z QubesOS, że system ten wymaga pewnego poziomu wiedzy informatycznej. Korzystanie z QubesOS wiąże się z pewnymi niedogodnościami, zwłaszcza jeśli jest to główny system komputerowy. Podobnie QubesOS nie będzie dobrze działać w niektórych przypadkach (z założenia), np. w przypadku akceleracji 3D w maszynach wirtualnych. Ważne jest, aby od samego początku jasno to wyjaśnić, nie po to, aby zniechęcić ludzi do korzystania z systemu, ale aby określić oczekiwania potencjalnych użytkowników.
Czym jest QubesOS, a czym nie jest
Chociaż QubesOS to specjalny rodzaj systemu operacyjnego (dystrybucja Xen), warto byłoby porównać go z innymi systemami operacyjnymi na podstawie ich funkcjonalności lub ich braku (np. Windows coraz częściej wykorzystuje wirtualizację i piaskownicę jako mechanizmy zabezpieczeń). Można użyć prostego diagramu lub tabeli.
Specyfikacje przewodnika zostaną określone wspólnie ze społecznością.
Jakie minimalne informacje powinien zawierać przewodnik? Jak bardzo można uprościć instalację bez poświęcania bezpieczeństwa? Gdzie powinna znajdować się granica? Czy istnieje minimalnie opłacalna i bezpieczna konfiguracja QubesOS? Jeśli nie, można ją zdefiniować i ustawić jako cel przewodnika.
Licencja
Wybierz licencję. Ceniona wiki Archlinux używa licencji GNU Free Documentation License w wersji 1.3 lub nowszej. Czy ta licencja będzie odpowiednia?
Inne działania
Uatrakcyjnienie dokumentacji witryny
Notatki można wyróżnić kolorem czerwonym lub żółtym, aby były łatwiejsze do zauważenia. Można na przykład użyć kolorowych pól, takich jak te, które znajdują się w wiki Archlinux: https://wiki.archlinux.org/index.php/Linux_Containers.
Można użyć bloków cytatów.
Treści linków
Obecnie w witrynie z dokumentacją jest sporo treści, ale poszczególne elementy często nie są powiązane z innymi odpowiednimi tematami. Aby zwiększyć wykrywalność, można połączyć ze sobą artykuły.