Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Django
- Pisarz techniczny:
- Gabbyprecional
- Nazwa projektu:
- Przeredaguj przewodnik dotyczący udziału w programie, aby był bardziej przyjazny dla użytkownika i łatwiejszy w nawigacji
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Streszczenie
Django, podobnie jak każda inna dokumentacja, ma na celu wskazanie użytkownikom, współtwórcom oprogramowania open source, w jaki sposób i gdzie mogą przyczynić się do ulepszenia Django.
Zawsze trzeba przygotować dokumentację, zwłaszcza taką, która ma istotny wpływ na społeczność i sam Django.
Celem tegorocznego „Lato Dokumentów Google” jest, aby Django był mniej przytłaczający, przystępny i przyjazny dla współtwórców. To ważny cel, ponieważ zachęca on współtwórców, do których należę, chcąc przyczynić się do powstania tej wspaniałej platformy.
Bieżący stan
Obecny etap dokumentacji, który można tu znaleźć, nie jest zbyt dużym przewodnikiem, ponieważ jest zbyt przytłaczający i mało dobrze zorganizowany. Z jego poziomu nie jest dostatecznie zrozumiały, a nowi współtwórcy nie są mile widziani.
Cele projektu
Moje sugestie dotyczące dokumentacji zostały omówione na forum z mentorem, Carltonem Gibsonem, i potwierdził, że może być on pomocny w rozwiązaniu ogromnego problemu dotyczącego bieżącej dokumentacji. Oto cele, jakie zamierzam osiągnąć podczas zmiany struktury dokumentu: Zmiana struktury dokumentu Dodanie sekcji zalecane i niezalecane Tworzenie pojedynczych stron z prostymi sekcjami, takimi jak Zgłaszanie próśb i tworzenie funkcji Słowniczek terminów Ograniczony i przejrzysty dokument Słowniczek terminów Wewnętrzny indeks stworzony zgodnie z nowym przewodnikiem Napisać bardziej przystępną dokumentację dla twórców Dzielić treści na 2 główne części (dla początkujących i dla twórców) w celu zachowania zgodności z sekcją dla początkujących i dla twórców
Obecna dokumentacja jest już przeznaczona dla zaawansowanych współtwórców i nie daje szansy zarówno początkującym, jak i nowym współtwórcom zarówno oprogramowania open source, jak i Django. Oto dodatkowe materiały dla początkujących: Sekcja z przewodnikami dla różnych uczestników(twórców technicznych, projektantów i programistów) Strona, na której znajdują się informacje o problemach typu open source i łatwe do rozwiązania. Trzeba wypełnić kilka sekcji w obecnej dokumentacji, przeredagować treść i dodać ją do sekcji dla początkujących. Sekcje, które wyjaśniają najważniejsze kwestie lub terminy używane w sekcji dla zaawansowanych.
Oś czasu
Oto zestawienie informacji o tym, jak chcę pracować nad osiągnięciem celu projektu zgodnie z powyższym opisem, korzystając z kalendarza dostarczonego przez Google.
Tydzień budowania więzi ze społecznością( 17–13 września) Tworzenie dodatkowych sekcji Dokumentacja Wewnętrzny styl pisania współtwórców 7 Dodatkowy wkład w dokumentację Więcej sugestii od współtwórców Więcej sugestii od współtwórców Więcej materiałów o aktualnej dokumentacji i przeznaczonych narzędziach Tydzień 1–4. Rozpoczęcie od opracowania dokumentacji na podstawie Poziomów Tworzenie sekcji dla początkujących – Przygotowanie do wprowadzenia zmian w dokumentacji Tydzień 4 – 6 Dodatkowa dokumentacja i wskazówki dotyczące przeprowadzek
Narzędzia,
Sphinx – bieżące narzędzie do bieżącej dokumentacji. Przeczytaj dokumenty.
Dlaczego ten projekt?
Wierzę, że dobrze napisane dokumenty i artykuły powinny być przydatne dla wszystkich użytkowników na całym świecie. Poza tym uwielbiam Django i open source jako całość. Początkowo chciałem współtworzyć Django i myślę, że to świetny sposób na ulepszenie mojego ulubionego narzędzia, a także poznanie bazy kodu, dzięki której deweloperzy(i twórcy techniczni) mogą w czymś pomóc. Praca z organizacją, która odpowiada moim poglądom, jest przyjemna i piękna, a to dla mnie doskonałe narzędzie w całej mojej karierze.
Dlaczego jestem odpowiednią osobą do tego projektu?
W oparciu o następujące konta uważam, że jestem odpowiednią osobą, aby pomóc początkującym w lepszym zrozumieniu Django. Jako deweloper i deweloper, który chce uczestniczyć w rozwoju Django, rozumiem potrzeby innych deweloperów i dobrze udokumentuję je. Należę do zespołu i dobrze sobie radzę pod nadzorem mojego mentora, Carltona Gibsona.