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
- moja global
- Pisarz techniczny:
- Anthony
- Nazwa projektu:
- Dokumentacja kodu narzędzia do raportowania
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W związku z możliwością udokumentowania narzędzia do raportowania dla organizacji Moja Global proponuję opracowanie 6 rodzajów dokumentacji, która będzie wykorzystywana przez różnych odbiorców do różnych celów. Są to:
1) Przewodnik konfiguracji środowiska
1.1) Grupa docelowa Inżynierowie systemowi
1.2) Cel Pomóż inżynierom systemów w skonfigurowaniu lokalnego środowiska kompilacji i wykonania dla Narzędzia do raportowania.
1.3) Format Artykuł instruktażowy przedstawiający sekwencję czynności, które inżynierowie systemowi muszą wykonać, aby skonfigurować środowisko, które będzie sprzyjać tworzeniu i uruchamianiu narzędzia do generowania raportów.
2) Przewodnik po kompilacji
2.1) Grupa docelowa Inżynierowie systemowi
2.2) Cel Pomóc inżynierom systemowym w tworzeniu komponentów narzędzia do raportowania na podstawie kodu źródłowego
2.3) Format Artykuł instruktażowy przedstawiający sekwencję czynności, które inżynierowie systemowi muszą wykonać, aby uzyskać i skompilować kod źródłowy narzędzia do raportowania.
3) Przewodnik instalacji
3.1) Inżynierowie systemów docelowych odbiorców
3.2) Cel Pomoc inżynierom systemowym w instalowaniu nowo utworzonych komponentów narzędzia do raportowania
3.3) Sformatuj artykuł z instrukcjami, który określa zestaw kolejnych kroków, które muszą wykonać inżynierowie systemów, aby wdrożyć narzędzie do raportowania w niedawno skonfigurowanym środowisku.
4) Przewodnik obsługi
4.1) Docelowi odbiorcy Integratorzy systemów
4.2) Cel Pomoc inżynierom systemowym w uruchamianiu świeżo zainstalowanej instancji narzędzia do raportowania
4.3) Format Przewodnik zawierający instrukcje, które opisują sekwencję kroków, które integratorzy systemów muszą wykonać, aby przesłać i przetworzyć bazy danych wyjściowych Flux w bieżącej instancji narzędzia do raportowania.
Przewodnik operacyjny Wprowadzanie i przetwarzanie wyjściowych baz danych Flux w narzędziu do raportowania
5) Przewodnik użytkownika
5.1) Docelowa grupa odbiorców Użytkownicy
5.2) Cel Pomóc użytkownikom zrozumieć różne funkcje wbudowane w narzędziu do raportowania oraz sposób ich używania.
5.3) Format Artykuł instruktażowy przedstawiający sekwencję czynności, które użytkownicy muszą wykonać, aby prawidłowo korzystać z funkcji narzędzia do raportowania.
6) Przewodnik dla programistów
6.1) Docelowi odbiorcy Programiści
6.2) Cel Pomóc użytkownikom zrozumieć różne funkcje wbudowane w narzędziu do generowania raportów oraz sposób ich używania.
6.3) Format artykułów referencyjnych opisujących: a) główne elementy graficzne, z których składa się narzędzie; b) funkcjonalny rozkład powyższych elementów; c) elementy wykonawcze elementów podzielonych funkcjonalnie; d) kod źródłowy narzędzia / organizacja bibliotek e) długoterminowa wizja i kierunek ciągłego doskonalenia f) logiczne kolejne obszary do poprawy.
oraz krótki samouczek, który opisuje, jak dostosować kod do konkretnych okoliczności użytkownika.