Szukasz kursu specjalistycznego z BHP, SEP lub kursu excel? Kurs edukacyjny!

Jaka dokumentacja jest potrzebna?

Co innego w dokumentacji jest potrzebne przypadkowemu użytkownikowi programu, co innego użytkownikowi, którego praca zależy od programu, a jeszcze co innego użytkownikowi, który musi dostosować program do swoich celów.

Do korzystania z programu. Każdy użytkownik musi mieć dostęp do tekstowego opisu programu. Większość dokumentacji zawiera jednak zbyt mało informacji przeglądowych. Opisuje się drzewa, mówi się o korze i liściach, ale brakuje mapy lasu. Aby opracować użyteczny opis tekstowy programu, trzeba uwzględnić kilka elementów.

– 1. Cel. Jaka jest główna funkcja programu? Do czego program służy?

– 2. Środoioisko. Na jakich maszynach, w jakiej konfiguracji sprzętowej i w jakiej konfiguracji systemu operacyjnego program będzie używany?

– 3. Obszary wejścia i wyjścia. Jaki obszar wejścia jest dopuszczalny? Jaki obszar wyjścia jest ustalony w programie?

– 4. Realizowane funkcje i używane algorytmy. Co dokładnie program robi?

– 5. Formaty danych wejściowych i zoyjściowych. Muszą być precyzyjne i pełne.

– 6. Instrukcje operacyjne, w tym standardowe i niestandardowe działania kończące obsługę programu, sygnalizowane na konsoli i urządzeniach wyjściowych.

– 7. Opcje. Co użytkownik ma do wyboru w odniesieniu do funkcji programu? Jak ten wybór jest przedstawiony?

– 8. Czas wykonywania. Ile czasu trwa rozwiązanie problemu określonej wielkości i w określonej konfiguracji?

– 9. Dokładność i sprawdzanie. Jaka jest przewidywana dokładność odpowiedzi? Jakie środki sprawdzania dokładności zostały uwzględnione?

Często wszystkie te informacje da się zmieścić na trzech lub czterech stronach. Trzeba jednak wtedy zwracać uwagę na zwięzłość i precyzję sformułowań. Większość z podanych tu elementów powinna być naszkicowana przed opracowaniem programu, bo dotyczy podstawowych decyzji planistycznych.

Do zaufania programowi. Opis sposobu korzystania z programu należy uzupełnić opisem jego działania. Oznacza to konieczność podania przykładów testowych. Do każdej kopii dostarczanego programu powinny być dołączone niewielkie przykłady testowe, żeby użytkownik mógł rutynowo sprawdzić, czy ma poprawną kopię, właściwie załadowaną do maszyny.

Podobne Artykuły

Zostaw odpowiedź

Twoj adres e-mail nie bedzie opublikowany.