Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Język Julii
- Pisarz techniczny:
- sofy
- Nazwa projektu:
- Odświeżenie strony FluxML
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Celem tej propozycji jest ulepszenie witryny z dokumentacją Flux w taki sposób, by zawarte w niej informacje były uporządkowane i atrakcyjne dla nowych użytkowników i ekspertów. Mówiąc dokładniej, celem jest uporządkowanie istniejącej dokumentacji w nowe sekcje i stworzenie nowego samouczka dla początkujących, stanowiącego uzupełnienie samouczka na temat 60-minutowego lunaparku.
Projekt składa się z tych faz:
Przeanalizować bieżącą witrynę z dokumentacją: skontroluj istniejące informacje i określ wskazówki redakcyjne (dotyczące informacji) przy tworzeniu nowych samouczków.
Zdefiniuj nową strukturę informacji i samouczek dla początkujących: współpracuj z mentorami nad nowymi sekcjami i reorganizacją witryny z dokumentacją. Na początek utwórz też spis treści samouczka dla początkujących. Wykorzystaj go jako punkt wyjścia.
Zmień strukturę informacji: uzupełnij witrynę o plan zdefiniowany we współpracy z mentorami w poprzednim kroku.
Utwórz samouczek dla początkujących: napisz pierwszą wersję roboczą i zapoznaj się z nią. Uzyskanie opinii od mentorów. Gdy razem z mentorami ustalimy, że mamy ostateczną wersję tego dokumentu, opublikujemy ją na stronie z dokumentacją.
(Opcjonalnie) Przekonwertuj obecną dokumentację w postaci plików README na kod HTML: jeśli po ukończeniu 4 głównych faz zostanie trochę czasu, mogę przekonwertować istniejące samouczki jako pliki README, aby ułatwić dostęp do nich z witryny.
Chcąc osiągnąć cel projektu, będę ściśle współpracować ze społecznością Flux, aby zrozumieć obecną dokumentację i wybrać najlepsze podejście. Dopiero zaczynam przygodę z Julią i myślę, że to będzie bardzo pomocne w określeniu odpowiedniego poziomu informacji na potrzeby nowego samouczka dla początkujących.
Skoncentruję się na tym, aby moje działania pomagały społeczności Flux wdrożyć nowe zastosowania. Skupię się też na pomaganiu doświadczonym użytkownikom w odkrywaniu nowych przypadków użycia i zgłębianiu szczegółów Flux.