Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- moja globalna
- Pisarz techniczny:
- Anthony
- Nazwa projektu:
- Dokumentacja kodu narzędzia do raportowania
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ze względu na możliwość udokumentowania narzędzia do raportowania dla organizacji Moja Global proponuję opracowanie 6 typów dokumentacji, które będą wykorzystywane przez różnych odbiorców do różnych celów. Poniżej znajdziesz podsumowanie tych informacji:
1) Przewodnik po konfiguracji środowiska
1.1) Docelowi odbiorcy Inżynierowie systemów
1.2) Cel Pomocą inżynierów systemu w skonfigurowaniu lokalnego środowiska kompilacji i wykonania dla narzędzia do raportowania.
1.3) Sformatowanie Instrukcji z zestawem czynności, które inżynierowie systemów muszą wykonać w celu skonfigurowania środowiska sprzyjającego tworzeniu i uruchamianiu Narzędzia do zgłaszania zagrożeń i nadużyć.
2) Instrukcja tworzenia
2.1) Docelowi odbiorcy Inżynierowie systemów
2.2) Cel Pomoc inżynierom systemowym w tworzeniu komponentów narzędzia do raportowania na podstawie kodu źródłowego
2.3) Format Instrukcja opisująca zestaw kolejnych czynności, które inżynierzy systemów muszą wykonać w celu uzyskania i skompilowania kodu źródłowego narzędzia do raportowania.
3) Przewodnik instalacji
3.1) Docelowi odbiorcy Inżynierowie systemów
3.2) Cel Pomoc inżynierom systemowym w instalowaniu nowych komponentów Narzędzia do raportowania
3.3) Sformatować Instrukcję opisującą zestaw kolejnych czynności, które inżynierowie systemów muszą wykonać, aby wdrożyć Narzędzie do raportowania w świeżo skonfigurowanym środowisku.
4) Instrukcja obsługi
4.1) Docelowi odbiorcy Integratorzy systemów
4.2) Cel Pomocą inżynierów systemu operacyjnego w uruchomieniu nowo zainstalowanego narzędzia do raportowania
4.3) Sformatować Instrukcję, która określa zestaw kolejnych czynności, które muszą wykonać integratorzy systemów w celu przesyłania i przetwarzania baz danych wyjściowych Flux za pomocą uruchomionego narzędzia do raportowania.
Przewodnik po operacjach Wprowadzanie i przetwarzanie baz danych wyjściowych strumienia w narzędziu do raportowania
5) Przewodnik użytkownika
5.1) Docelowi odbiorcy Użytkownicy
5.2) Cel Pomóż Użytkownikom zrozumieć różne funkcje wbudowane w Narzędzie do raportowania i dowiedzieć się, jak z nich korzystać.
5.3) Sformatować Instrukcję, która określa zestaw kolejnych czynności, które Użytkownicy muszą wykonać w celu prawidłowego korzystania z Funkcjonalności Narzędzia do raportowania.
6) Przewodnik dla programistów
6.1) Docelowi odbiorcy Programiści
6.2) Cel Pomoc użytkownikom w poznaniu różnych funkcji dostępnych w Narzędziu do raportowania i sposobu ich wykorzystania.
6.3) Format Artykuły referencyjne, które opisują: a) główne elementy projektu, które składają się na narzędzie, b) rozkład funkcjonalny tych elementów, c) elementy wykonawcze rozłożonych elementów pod względem funkcjonalności, d) kod źródłowy narzędzia / organizację bibliotek, e) długoterminową wizję i kierunek dalszego doskonalenia, f) logiczne obszary do poprawy.
Krótki samouczek pokazujący, jak dostosować kod do specyficznych sytuacji użytkownika