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
- Django
- Pisarz techniczny:
- Gabbyprecious
- Nazwa projektu:
- Przewodnik dotyczący redagowania treści, aby był bardziej przyjazny dla użytkownika
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
ABSTRACT
Podobnie jak w przypadku każdej innej dokumentacji celem przewodnika Django jest wskazanie współtwórcom open source, w tym przypadku, jak i gdzie mogą przyczynić się do ulepszania i zrównoważonego rozwoju Django.
Trzeba zawsze przygotowywać dokumentację, która ma znaczący wpływ na społeczność i same Django.
W tym roku celem Django w ramach Google Summer of Docs jest sprawienie, aby przewodnik dla autorów był mniej przytłaczający, bardziej przystępny i przyjazny dla autorów. Jest to bardzo ważny cel, ponieważ zachęca twórców, do których sam należę, do tworzenia treści w ramach tej świetnej platformy.
Bieżący stan
Obecny stan dokumentacji, którą można znaleźć tutaj, nie jest zbyt dobrym przewodnikiem, ponieważ jest zbyt przytłaczający i źle ustrukturyzowany. Nie ułatwia ona też zrozumienia, jak można przyczynić się do rozwoju Django, i nie zachęca nowych autorów do udziału w tym projekcie.
Cele projektu
Omówiłem moje propozycje dotyczące dokumentacji z moim mentorem Carltonem Gibsonem na forum i on zgadza się, że to pomoże rozwiązać problem z obecną dokumentacją. Oto cele, które chcę osiągnąć, zmieniając strukturę dokumentu: Zmienić strukturę dokumentu. Dodaj sekcje z instrukcjami i wskazówkami. Utwórz pojedyncze strony dla prostych sekcji, takich jak żądanie i tworzenie funkcji. Zredukuj dokumentację i skoncentruj się na najważniejszych kwestiach. Utwórz glosariusz z definicjami słów. Utwórz wewnętrzny indeks zgodny z nowym przewodnikiem. Utwórz bardziej przystępną dokumentację. Podziel zawartość na 2 części (sekcje dla początkujących i zaawansowanych autorów). Przygotuj przewodnik i styl dla nowych autorów i współtwórców dokumentacji, aby utrzymać aktualność dokumentów i przestrzegać standardów.
Obecna dokumentacja jest skierowana do zaawansowanych użytkowników i nie uwzględnia nowych i początkujących twórców ani open source, ani Django. Oto dodatkowe materiały dla początkujących: Sekcja z instrukcjami dla różnych grup twórców(pisarzy technicznych, projektantów i programistów) Strona z informacjami o problemach, które mogą napotkać początkujący użytkownicy, i prostymi problemami, które można rozwiązać. Wybierz kilka sekcji z obecnej dokumentacji, przerób je i dodaj do sekcji dla początkujących. Sekcje wyjaśniające najważniejsze punkty lub słowa używane w sekcji zaawansowanej.
Oś czasu
Oto szczegółowy opis tego, jak chcę pracować nad realizacją celu projektu (wymienione powyżej) z wykorzystaniem kalendarza udostępnionego przez Google.
Tydzień nawiązywania kontaktów z komunitą( 17 sierpnia–13 września) Więcej informacji o współpracy z komunitą Kontynuowanie tworzenia dokumentacji Zbieranie większej liczby sugestii od współtwórców Dodatkowe badania dotyczące obecnej dokumentacji i przewidywanych narzędzi Tydzień 1–4 Rozpoczęcie dzielenia dokumentacji na sekcje na podstawie poziomów Tworzenie sekcji dla początkujących w dokumentacji Tydzień 4–6 Tworzenie listy „Do i nie do zrobienia” Tworzenie listy „Do i nie do zrobienia” dla poszczególnych sekcji Dodatkowe strony dla sekcji Tydzień 7–9 Przepisywanie i przenoszenie obecnej dokumentacji do przewodnika dla zaawansowanych współtwórców Ograniczenie objętości dokumentacji Tydzień 10–12 Przygotowanie słownika Aktualizacja wewnętrznego indeksu w nowej dokumentacji Przygotowanie przewodnika i stylu dla nowych autorów/współtwórców dokumentacji
Narzędzia
Sphinx – aktualne narzędzie do bieżącej dokumentacji. Przeczytaj dokumenty.
Dlaczego ten projekt?
Głęboko wierzę w dobrze napisane dokumenty i artykuły skierowane do osób na całym świecie. Poza tym jestem też fanem Django i otwartego oprogramowania. Początkowo chciałem(-am) pomóc w pracy nad Django. Myślę, że jest to doskonały sposób na stworzenie mojego ulubionego narzędzia, a jednocześnie zapoznania się z bazą kodu. Współpraca z organizacją, która zgadza się z moimi poglądami, to przyjemność i wspaniała współpraca.
Dlaczego jestem odpowiednią osobą do tego projektu?
Uważam, że jestem odpowiednią osobą do udzielenia pomocy, ponieważ: Uczestniczę w projektie Django, pisząc artykuły, które pomagają początkującym lepiej zrozumieć Django. Jako programista i osoba, która chce przyczynić się do rozwoju Django, rozumiem potrzeby innych deweloperów i wiem, jak dobrze je udokumentować. Jestem osobą, która lubi pracować w zespole i będę dobrze pracować pod nadzorem mojego mentora Carltona Gibsona.