Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source
- Język Julia
- Pisarz techniczny:
- sophb
- Nazwa projektu:
- Nowa strona FluxML
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ta propozycja ma na celu ulepszenie witryny dokumentacji Flux, tak aby zawarte w niej informacje były uporządkowane i atrakcyjne dla początkujących i zaawansowanych użytkowników. Chodzi dokładnie o to, aby zreorganizować istniejącą dokumentację w nowe sekcje i utworzyć nowy samouczek dla początkujących, który rozszerzy samouczek Blitz dla Fluxa 60.
Projekt składa się z tych faz:
Analiza bieżącej witryny z dokumentacją: sprawdzenie istniejących informacji i zdefiniowanie przewodnika stylistycznego (informacje) przy tworzeniu nowych samouczków.
Definiowanie nowej struktury informacji i samouczek dla początkujących: wspólnie z mentorami określ nowe sekcje i uporządkuj witrynę z dokumentacją. Na podstawie samouczka Blitz dla Fluxa 60 Mine określ też spis treści samouczka wprowadzającego.
Zmień strukturę informacji: zaktualizuj stronę internetową zgodnie z planem opracowanym we współpracy z mentorami w poprzednim kroku.
Utwórz samouczek wprowadzający: napisz pierwszą wersję roboczą i go przejrzyj. uzyskać opinię mentorów; Gdy razem z mentorami uznamy, że mamy już ostateczną wersję tego dokumentu, opublikuję go na stronie dokumentacji.
(Opcjonalnie) Konwertowanie istniejącej dokumentacji w formie README na format HTML: jeśli po zakończeniu 4 głównych faz pozostanie mi trochę czasu, mogę przekonwertować istniejące samouczki w formie README, aby łatwiej było do nich uzyskać dostęp z witryny.
Aby osiągnąć cel projektu, będę ściśle współpracować ze społecznością Flux, aby poznać i zastosować najlepsze podejście. Jestem świeżo upieczoną osobą w Julii i myślę, że te informacje będą bardzo pomocne w określeniu odpowiedniego poziomu informacji zawartych w tym samouczku.
Będę się skupiać na tym, aby moja praca pomagała społeczności Flux w przygotowaniu się na nowych użytkowników. Poświęcę też trochę czasu na pomoc doświadczonym użytkownikom w odkrywaniu nowych zastosowań i szczegółów dotyczących Flux.