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
- Pisarz techniczny:
- Krezhairo
- Nazwa projektu:
- Przewodnik użytkownika i przewodnik funkcji Calc
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
PROŚBA O PROJEKT
W fazie pisania technicznego mogę poświęcić 30–35 godzin tygodniowo, a w fazie przygotowań do pisania – 10–12 godzin. Dzięki temu będę mogła nauczyć się umiejętności potrzebnych do realizacji projektu. Chcę Cię poinformować, że obecnie mieszkam na Uniwersytecie(w moim kraju), gdzie mam dostęp do szybkiego internetu i wszelkie dodatkowe zasoby potrzebne do realizacji projektu. Z powodu pandemii COVID-19 uczęszczam na uczelnię przez cały czas trwania projektu. Na razie nie zaczynam w najbliższym czasie i nawet jeśli w ostatnim roku miałby to wpływ na 5 godzin projektu,
WPROWADZENIE
LibreOffice Calc ma obszerną listę (ponad 500 funkcji) w wielu kategoriach, których dokumentacja w pomocy jest dość skąpa (ale mimo to dokładna). Wbudowany w Calc kreator funkcji zawiera też podsumowanie informacji o celu i parametrach każdej funkcji. W wiki Fundacji The Document Foundation została utworzona struktura, która zawiera bardziej szczegółowe informacje o funkcjach Calca.
CEL
Aby wypełnić strukturę wiki, pisząc bardziej szczegółowe treści dla każdej funkcji Calca, warto było oznaczyć zgodność ze standardem ODFF, w tym ilustracje i diagramy, podać jeden lub dwa przykłady, aby wskazać szczególne przypadki i wyjątki, oraz udostępnić przykładowe pliki.
PLAN PRACY PROJEKTOWEJ
Dokładnie zapoznaję się z główną koncepcją projektu i staramy się udokumentować działanie każdej funkcji w kreatorze funkcji oraz wraz z wystarczającymi przykładami dotyczącymi każdej z nich, przedstawiając wszystkie aspekty tych funkcji i staram się przygotować dokumentację w jak najbardziej intuicyjny sposób, aby nowy użytkownik mógł ją znaleźć i w ciągu kilku sekund zrozumieć, jak z nich korzystać.
Proponuję podzielić te funkcje według kategorii:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
Każda z nich zawiera około 20–50 funkcji, a niektóre kategorie mają ich więcej. Większość z nich zawiera krótki opis z syntaksą i jednym przykładem.
Chcę dodać bardziej szczegółowe informacje dotyczące każdej funkcji Calc, zgłosić zgodność ze standardem ODFF, w tym ewentualne ilustracje i schematy, podać jeden lub dwa przykłady w formie uwag i przykładów, aby wskazać przypadki narożne i wyjątki, oraz podać przykładowe pliki. W razie potrzeby dodaj też ważną sekcję. Rozważę omówienie tych funkcji w formacie tematycznym, czyli omówienie jednej funkcji i przejście do kolejnej w ramach danej kategorii w trakcie pisania tekstu technicznego. Poza tym warto przyzwyczaić się do środowiska pracy podczas okresu nawiązywania kontaktów z lokalną społecznością, aby ułatwić sobie pisanie. Z moich doświadczeń wynika, że odkrycie wszystkich tych małych „aha!” podczas dokumentowania tego typu aplikacji wymaga poświęcenia czasu. Jeśli chodzi o planowanie, na początku postawiłbym na ten projekt w 11 kategoriach. Oczywiście niektóre z nich będą wymagać więcej pomocy i więcej czasu niż inne. Można jednak rozwiązać te problemy w trakcie pracy. Ponieważ istnieje już pewna dokumentacja, a ja piszę na jej podstawie, rozważę sprawdzanie poprawności po zakończeniu każdego tygodnia, ponieważ nie jest dobrze zostawiać to na ostatni tydzień.
Poniżej przedstawiamy przybliżony harmonogram organizacji projektu w określonym czasie.
- Tydzień 1 (14 września) • Baza danych
- Tydzień 2 (21 września) • Data i godzina
- Tydzień 3:(28 września) • Finanse
- Tydzień 4 (5 października) • Informacje
- Tydzień 5:(12 paź) • Logiczne
- Tydzień 6 (19 października) • Matematyka
- Tydzień 7 (26 października) • Tablica
- Tydzień 8:(2 lis) • Statystyki
- Tydzień 9 (9 listopada) • Arkusz kalkulacyjny
- Tydzień 10 (16 listopada) • Tekst
- Tydzień 11 (23 listopada) • Wtyczka
- Tydzień 12:(30 XI–5 XII)(ostateczny)
Udokumentowanie wykonanej pracy i doświadczeń zdobytych podczas tego projektu oraz zajęcie się drobnymi sprawami, w tym 2 przeczytania/edytowania (w razie potrzeby) w celu przygotowania dokumentacji do przesłania.