Projekt Dokumentacja U┼╝ytkownika


Projekt:

Program zarządzający gospodarką magazynową.

Dokumentacja Użytkownika.

Krzysztof Kula

Lab 3

III studiów zaocznych

WSEIP

Spis treści:

  1. Wstęp

Program został napisany z wykorzystaniem środowiska programistycznego wxDev-Cpp, który jest całkowicie darmowy oraz domyślnie umożliwia programowanie z wykorzystaniem bibliotek wxWidgets. Program porozumiewa się z lokalną bazą danych wykorzystując lokalnie zainstalowany silnik bazy danych Firebird - najlepiej w wersji 2.x.x. ale o tym w następnym rozdziale. Program umożliwia proste zarządzanie magazynami oraz dodawanie nowych towarów i ich usuwanie z magazynów poprzez wykorzystanie faktury VAT. Mimo że wszystkie dane są automatycznie uaktualniane, to możliwe jest także wymuszenie tej czynności np w przypadku jednoczesnej pracy kilku osób na tej samej bazie, - choć nie jest to w żaden inny sposób wspierane i nie zostało przetestowane. Program został szczegółowo przetestowany nie tylko przez jego twórcę, ale także osoby postronne, co pozwoliło usunąć wiele naprawdę nieprzyjemnych błędów typu „runtime errors”. Życzę miłej i bezawaryjnej pracy z programem.

  1. Czynności przed uruchomieniem programu

Nim program zostanie uruchomiony koniczne jest zainstalowanie na swoim komputerze silnika bazy danych Firebird - najlepiej w wersji 2 do współpracy, z którą program został przygotowany. Najlepiej uruchomić go w trybie aplikacji - dzięki temu system(XP) zapyta nas czy powinien otworzyć port w Firewallu. Nie jest to jednakże żaden wymóg, najważniejsza jest, bowiem wygoda użytkownika (zauważyłem jednak, że daje to lepsze efekty i praktycznie zawsze działa). Po zainstalowaniu i konfiguracji Firebirda, które są na tyle proste, że nie muszę tego opisywać należy uruchomić program podwójnie klikając na plik Baza3.exe - baza jest bowiem już trzecim projektem tego typu programu. Po uruchomieniu widoczny jest tzw. „splash screen”, na którym widoczne są ikony bibliotek i programów wykorzystywane do stworzenia programu, (aby dowiedzieć się więcej czytaj: „Dokumentacja Techniczna”).

  1. Okno główne programu i jego możliwości

Po uruchomieniu programu widoczne jest tzw. główne okno programu zawierające wszystkie główne opcje programu. W oknie widoczne jest menu obejmujące opcje „Baza”, „Magazyn” i „Help”. „Baza” pozwala na połączenie się z istniejącą bazą danych, tworzenie nowej bazy, zapisanie wszystkich zmian i zamknięcie programu. Czynności te są także możliwe poprzez Toolbox oraz przyciski tuż pod nim, ich działanie jest identyczne a używanie zależy od preferencji użytkownika. „Magazyn” obejmuje polecenia tworzenie nowego magazynu, otwierania magazynu i usuwania magazynu zaznaczonego na liście magazynów w środkowej części okna, ostatnią opcją jest otwarcie stanów magazynowych umożliwiających przegląd towarów niezależnie od magazynu, w którym się znajduje oraz odnalezienie towaru w przypadku, gdy nie wiemy, w którym magazynie się znajduje.

Pierwszą czynnością, jaką należy wykonać jest połączenie się z bazą danych, lub stworzenie nowej bazy, z którą program połączy się automatycznie. Bazę można także zapisać to znaczy zaakceptować wszystkie wprowadzone zmiany, nie jest to zwykle konieczne, ale tuż przed zamknięciem zaleca się to zrobić. Zamknięcie programu jest jednoznaczne z rozłączeniem się z bazą danych, - jeśli chcemy zacząć pracować z inną bazą w trakcie działania programu trzeba ją po prostu wczytać lub stworzyć, aktualnie otwarta baza zostanie automatycznie zamknięta.

Zarządzanie magazynami pozwala na stworzenie nowego magazynu - przykładowa nazwa zostaje użytkownikowi zaproponowana, możliwa jest oczywiście jej edycja i stworzenie magazynu o dowolnej nazwie, niewskazane jest jednak stosowanie znaków innych niż litery i liczby - może to powodować krytyczne błędy (ze strony programu, ale także Firebirda). Nowy magazyn zostaje automatycznie otwarty. Na liście magazynów można wybrać tylko jeden magazyn: dostępne akcje to otwarcie i usunięcie magazynu - poprzez użycie przycisków znajdujących się po prawej stronie listy. Otworzyć magazyn można też poprzez szybkie podwójne na nim kliknięcie lewym przyciskiem myszy.

Jako ostatnie zostanie omówiona opcja „Stany Magazynowe”. Otwiera ona okno pozwalające przeglądać towary ze wszystkich magazynów jednocześnie.

  1. Okno magazynu

Po stworzeniu nowego magazynu, lub otwarciu istniejącego otwiera się okno zarządzania magazynem. W oknie widoczne są: tabela zawierająca dane towarów w magazynie, oraz trzy przyciski określające dostępne akcje: dodawanie nowych towarów poprzez nową fakturę zakupu, faktura sprzedaży towarów z magazynu, oraz przycisk umożliwiający odświeżenie danych widocznych w tabeli towarów. Tabela towarów ma następujące pola: Symbol, Nazwa, Ilość, Jednostka miary, Cena oraz Wartość towarów w magazynie. Dodatkowy przycisk umożliwia zamknięcie okna magazynu.

  1. Okno faktury zakupu

Okno faktury zakupu zawiera pola określające dane faktury, nie ma jednak zaimplementowanych żadnych mechanizmów, jeśli chodzi o dane faktury jako takiej, a więc dostawcy, odbiorcy, numeru faktury itd. Jednak zarządzanie towarami zostało zautomatyzowane - tzn. należy wypełnić dane towaru (oprócz zaznaczonych kolorem) a następnie kliknąć przycisk „Zaakceptuj towar”, który powoduje wypełnienie kolorowych pól obliczonymi wartościami, oraz umożliwia wpisanie następnego towaru. Jeśli towar znajduje się już w magazynie jego wartość i ilość zostaną automatycznie zwiększone. W przypadku popełnienia jakiegoś błędu można usunąć już zaakceptowany towar przyciskiem „Usuń towar”. Automatycznie są także wypełniane pola „Razem” i „Do Zapłaty”. Po wypełnieniu należy kliknąć „Zaakceptuj”, aby zapisać dane towarów do magazynu, lub „Anuluj”, aby zrezygnować z wszelkich zmian.

  1. Okno faktury sprzedaży

Na pierwszy rzut oka przypomina okno faktury zakupu. Jednak liczba pól jest inna, podobnie jak w „papierowej” fakturze. Podobnie pola „Zaakceptuj towar” i „Usuń towar”, jednak po wpisaniu wszystkich danych musimy pamiętać, że towary, które sprzedajemy muszą się znajdować w magazynie, - jeśli tak nie jest to faktura nie zostanie zaakceptowana (nie można sprzedać czegoś, czego się nie ma) trzeba, więc uważać na poprawne wpisanie symbolu towaru.

  1. Okno stanów magazynowych

Okno stanów magazynowych jest dostępne z głównego okna programu, nie zawiera ono żadnych przycisków, a jedynym celem, w jakim zostało zaprojektowane jest przeglądanie stanów wszystkich magazynów. W centrum okna widoczna jest tabela podobna do tej w każdym magazynie, zawiera jednak jedną dodatkową kolumnę „Magazyn”, możliwe jest więc szybkie odnalezienie towaru (jeśli nie wiemy w którym magazynie coś zostało umieszczone) by następnie w głównym oknie programu otworzyć ten magazyn. Umożliwia także wgląd w faktyczne stany magazynów z poziomu jednego okna.

  1. Podsumowanie

Wszelkie pytania i oceny programu można przysyłać na adres: krzych.super@wp.pl. Ze swojej strony życzę miłej pracy z programem.



Wyszukiwarka

Podobne podstrony:
projekt 1 dokument wstępny
BIUROTECHNIKA PROJEKT, Dokumenty, studia, notatki, itp, Biurotechnika
projekt 1 dokument wstępny
projektZAP dokumentacja koncowa Łukasz Kinel gr17 , Student:
projekt, Dokumentacja
TRPS projekt M.G, Dokumenty Inżynierskie, TRPS, Tprs, TRPS, TRPS WISNIA, TRPS mój projekt
projekt Dokumentacja
instrukcja rozpowszechnania dokumentacji, EKONOMIA, Projektowanie dokumentacji systemowej
trps nowy projekt, Dokumenty Inżynierskie, TRPS, Tprs, TRPS projekt
Projekt Dokumentacja Techniczna
Proces wałka stopniowanego - projekt, Dokumenty - technik mechatronik
projekt dokumentacji Borzęcki Andruszkiewicz Jasiński, IIS PWSZ, inżynieria oprogramowania, io
projekt 1 dokument wstępny
Wykład 3 Dokumentacja projektowa i STWiOR
O czym powinien pamiętać projektant domowej instalacji wentylacyjnej, ۞ Dokumenty, UPIĘKSZAMY MIESZK
GAITC Dokumentacja projektu
DU202poz2072 Szczegółowy zakres i forma dokumentacji projektowej

więcej podobnych podstron