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:
- Open Source Geospatial Foundation
- Pisarz techniczny:
- flicstar
- Nazwa projektu:
- Sprawdź krótkie wprowadzenia do OSGeoLive
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Cel
- Aktualizuj dokumenty, aby były aktualne, dokładne i trafne.
- Utwórz szablon, aby zapewnić spójność dokumentów i dodanych w przyszłości nowych poradników.
Odbiorcy
- Nowi użytkownicy OSGeo na żywo
- Autorzy nowych krótkich wprowadzenia do OSGeo Live
Dostawa
- Wiki
Oto, co moim zdaniem należy zrobić:
- Przejdź przez 50 dostępnych już krótkich wprowadzenia do OSGeo Live
- Dodawanie znaczników ze zmianami. Wyślij do sprawdzenia.
- Wdrożenie opinii
- Utwórz szablon szybkiego uruchomienia, aby wdrożyć spójność w przyszłości.
- Zaktualizuj sekcję „Jak wykonać procedurę Szybki start”.
- Dodawanie nowych aplikacji do OSGeoLive – potrzebują one samouczków.
Proponuję wykonać następujące czynności:
Przejrzyj 50 dotychczasowych przewodników Szybki start OSGeo Live i oznacz je adnotacjami. Do tego celu możesz użyć tych stron:
Nowość: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Stara wersja: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Tworzenie problemów związanych z dokumentacją w trac (narzędzie do śledzenia problemów)
Prześlij raport podsumowujący wyniki. Na przykład procent z 50, które wymagają minimalnego, średniego lub dużego nakładu pracy.
Utwórz szablon szybkiego uruchomienia, aby wdrożyć spójność na przyszłość.
Zaktualizuj stronę „Jak udokumentować plik Quickstart”.
Co będzie dostępne na koniec programu SoD:
- 50 zgłoszeń na dokumentację w trakcie traktowania z krótkimi wprowadzeniami utworzonymi na podstawie uzgodnionego szablonu krótkiego wprowadzenia
- Zrzut ekranu z aktualnym stanem podręczników wideo OSGeo Live i ilością pracy potrzebnej do ich zaktualizowania.
- zaktualizowany szablon Szybki start zgodny z szablonem Przewodnika szkoleniowego;
- zaktualizowany proces dokumentacji krótkich wprowadzeniach;
Od czego zacząć:
- Aby sprawdzić, które pakiety uległy zmianie między wersjami, otwórz arkusz Pakiety OSGeo-Live.
- Zapytaj na liście mailingowej OSGEo Live, czy są jakieś konkretne Szybkie starty, od których warto zacząć.
Co już zrobiliśmy:
- Skonfiguruj maszynę wirtualną i zainstaluj OSGeoLive
- Utworzono rozwidlenie repozytorium OSGeoLive-Doc
- Uzyskał dostęp do trac i przejrzał niektóre istniejące zgłoszenia dotyczące dokumentów. Bilet 1382 wydaje się odpowiedni: https://trac.osgeo.org/osgeolive/ticket/1382
- uczestniczył(a) w dyskusjach dotyczących list adresowych
- odbyły kilka nieformalnych rozmów wideo.