Dokumentacja obsługi programów Kamil Smużyński Piotr Kościński

Dokumentacja zawiera opis: Wymaganych zasobów sprzętowych Wymaganych zasobów sprzętowych Etapów instalacji Etapów instalacji Sposobów uruchamiania programu Sposobów uruchamiania programu Możliwości oprogramowania Możliwości oprogramowania Wprowadzania danych Wprowadzania danych Reprezentacji wyników przetwarzania Reprezentacji wyników przetwarzania Archiwizacji wyników pracy Archiwizacji wyników pracy

Zasoby sprzętowe Platforma Platforma –Procesor –Dostępna pamięć –Wolne miejsce na dysku –Wymagane interfejsy –Stacje dysków System operacyjny, wersja System operacyjny, wersja Środowisko uruchomieniowe, wersja Środowisko uruchomieniowe, wersja

Kroki instalacji Umiejscowienie na dysku Umiejscowienie na dysku Licencja Licencja Wybór instalowanych składników Wybór instalowanych składników Rejestracja Rejestracja Sposób aktualizacji oprogramowania Sposób aktualizacji oprogramowania Możliwość deinstalacji Możliwość deinstalacji

Uruchomienie programu Składnia poleceń tekstowych Składnia poleceń tekstowych Uruchomienie graficznego interfejsu użytkownika Uruchomienie graficznego interfejsu użytkownika Okno główne Okno główne Sposób przywracania przestrzeni roboczych Sposób przywracania przestrzeni roboczych

Funkcjonalność programu Paski narzędzi, pasek stanu, menu, ikony Paski narzędzi, pasek stanu, menu, ikony Sposób otwierania plików Sposób otwierania plików Interakcja z użytkownikiem Interakcja z użytkownikiem Nawiązywanie połączenia ze sprzętem Nawiązywanie połączenia ze sprzętem –Wybór interfejsu, szybkość –Wybór numeru portu, adresu Funkcje typowe dla aplikacji Funkcje typowe dla aplikacji Korzystanie z pomocy Korzystanie z pomocy

Wprowadzanie danych Wybór typu danych Wybór typu danych Kontrola zakresów Kontrola zakresów Importowanie danych Importowanie danych

Reprezentacja wyników przetwarzania Sposób wyświetlania Sposób wyświetlania Generowanie wykresów, tablic Generowanie wykresów, tablic Informacja o błędach Informacja o błędach Raporty Raporty

Zapis wyników pracy Do pliku Do pliku Wybór formatu Wybór formatu Eksport danych Eksport danych Drukowanie wyników, wykresów Drukowanie wyników, wykresów

Dokumentacja ta powinna zawierać wszystko, co potrzebne użytkownikowi końcowemu, aby mógł w pełni wykorzystać program bez pomocy autora.

Dokumentacja techniczna Użyte środowisko programistyczne – język Użyte środowisko programistyczne – język Ustawienia kompilatora Ustawienia kompilatora Schemat blokowy Schemat blokowy Sieci działań Sieci działań Użyte zmienne wraz z opisem Użyte zmienne wraz z opisem Listingi programów z komentarzami Listingi programów z komentarzami

Dokumentacja techniczna oprogramowania zawiera elementy niezbędne dla programistów, którzy w przyszłości chcieliby rozbudować aplikację.