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:
- LibreOffice
- Specjalista ds. technicznych:
- quaffeine
- Nazwa projektu:
- Przewodnik po LibreOffice Online: przewodnik podobny do tych używanych w innych aplikacjach LO, który obejmuje nie tylko korzystanie z aplikacji, ale także instalację i administrację.
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jeśli się zakwalifikuję, zamierzam poświęcić od 8 do 10 godzin tygodniowo na pisanie nowych materiałów, a także na modyfikowanie i ponowne wykorzystywanie istniejących materiałów w przewodniku po LibreOffice Online (LOOL). Przy mojej zwykłej szybkości pisania i poświęcaniu 8–10 godzin tygodniowo spodziewam się, że przewodnik będzie miał co najmniej 200 stron.
Używam tych aplikacji, odkąd jestem StarOffice, i dobrze znam się na zaawansowanych funkcjach wersji na komputery, takich jak:
- style w aplikacjach,
- Dokumenty główne, wzajemne odniesienia, ilustracje i koncepcje DTP w Writerze
- Wykresy i analizy danych w Calc
- funkcje interaktywnej prezentacji, takie jak przejścia i animacje w Impress;
Korzystałam z nich zarówno w pracy, jak i w wolnym czasie.
Przewodnik jest skierowany do średniozaawansowanych użytkowników, ponieważ najprawdopodobniej są to osoby, które dysponują umiejętnościami, cierpliwością i przede wszystkim chętnym skorzystaniem z oferty „LOOL”. W przypadku materiałów referencyjnych powinny się w nich oczywiście znajdować proste instrukcje (np. jak pogrubić zaznaczony tekst), ale należy też założyć, że użytkownik zna niektóre pojęcia techniczne (np. że serwer WWW odpowiada za przesyłanie aplikacji do przeglądarki).
Na początku planowania projektu warto zastosować poniższy harmonogram. Uwaga: kolejność, w jakiej piszę rozdziały, nie musi koniecznie wskazywać na to, gdzie w ostatecznej wersji Przewodnika znajdą się poszczególne rozdziały.
Tydzień 1. Zapoznanie się z instrukcjami instalacji, testowanie różnych metod instalacji, zapoznanie się z aplikacjami
Celem w tym tygodniu będzie sprawna instalacja LOOL. Z moich doświadczeń wynika, że odkrycie wszystkich tych małych „aha!” podczas dokumentowania tego typu aplikacji wymaga poświęcenia czasu. Chcę, aby w tym tygodniu udało się nam doprowadzić do tego, że aplikacja będzie można zainstalować za pomocą dowolnej dostępnej metody bez napotkania tych przeszkód.
Tydzień 2. Instalacja referencyjna, metody instalacji dokumentów
Ten tydzień zostanie poświęcony na stworzenie wstępnej listy instrukcji instalacji (nie w pełnym formacie, ale raczej „z liczbami”) oraz kilku notatek, które zostaną uwzględnione w kolejnych rozdziałach.
Tydzień 3. Napisz wstęp lub rozdziały wstępu(wstęp, wprowadzenie, informacje o tym przewodniku itp.).
Celem tego tygodnia jest przygotowanie co najmniej 1 pełnego, dopracowanego rozdziału zawierającego wszystkie istotne informacje, których czytelnik potrzebuje przed instalacją.
Tydzień 4. Pisanie rozdziałów instalacji, część 1
Celem tego tygodnia jest stworzenie kompletnych, dopracowanych instrukcji instalacji niektórych dostępnych metod w standardowym formacie rozdziału przewodnika LibreOffice, ale w formie, która pozwoli na łatwe wykorzystanie ich np. na Wiki.
Tydzień 5. Napisz rozdziały dotyczące instalacji, część 2
W tym tygodniu chcemy przygotować kompletne, dopracowane instrukcje instalacji pozostałych metod w formacie zwykłego rozdziału Przewodnika LibreOffice, ale w taki sposób, aby można je było łatwo wykorzystać np. w wiki.
Tydzień 6. Napisz rozdział dotyczący konfiguracji po instalacji
W tym tygodniu mamy pełne i dopracowane rozdziały poświęcone konfiguracji po instalacji, w tym konfigurowania ustawień aplikacji (np. strefy czasowej), konfigurowania użytkowników i innych przygotowań, które administrator musi wykonać przed wdrożeniem systemu w środowisku produkcyjnym.
Tydzień 7. Rozdziały dotyczące nawigowania po zapisie, interfejsu i zarządzania plikami
Celem tego tygodnia są pełne, dopracowane rozdziały, które po przeczytaniu sprawią, że czytelnik będzie mógł posługiwać się interfejsem użytkownika znajomo i wygodnie.
Tydzień 8. Tworzenie tekstu (edytowanie tekstu) – rozdziały
W tym tygodniu powinny pojawić się pełne, dopracowane rozdziały, dzięki którym użytkownicy będą mogli tworzyć elegancko urządzone dokumenty bezpośrednio w aplikacji.
Tydzień 9. Napisz rozdziały dotyczące arkuszy kalkulacyjnych
W tym tygodniu celem jest stworzenie kompletnych, dopracowanych rozdziałów, które pozwolą użytkownikowi na tworzenie funkcjonalnych arkuszy kalkulacyjnych, w tym z wybraną grupą obsługiwanych formuł i wykresów.
Tydzień 10. Napisz rozdziały aplikacji Impress (prezentacja)
Celem tego tygodnia jest stworzenie kompletnych, dopracowanych rozdziałów, które pozwolą użytkownikowi na tworzenie interaktywnych prezentacji z możliwością ich wyświetlania w trybie offline i na żywo.
Tydzień 11. Pisanie rozdziałów na temat integracji
Celem 11. tygodnia jest ukończenie i dopracowanie rozdziałów, które dają użytkownikowi pełny obraz dostępnych opcji integracji. Szczegółowe wskazówki dotyczące integracji aplikacji będą prawdopodobnie podawane w postaci linków do odpowiednich zasobów, takich jak strony wiki Fundacji Document Foundation lub zintegrowane projekty.
Tydzień 12. Złożenie różnych elementów (appendicy, indeksów, tabel danych itp.), Pierwsza korekta/weryfikacja
Pod koniec tego tygodnia udostępnimy kompletny przewodnik z niemal ostateczną treścią i nienaruszonymi/czynnymi elementami, takimi jak odniesienia.
Tydzień 13: 2 etap edycji/korekty, sprawdzenie składu/rozkładu, przesłanie
W tym ostatnim tygodniu należy przesłać kompletny, ostateczny przewodnik, który został zredagowany pod kątem treści i prezentacji.