Zacznijmy od omówienia krótko tego, jak powstaje program komputerowy. Program komputerowy, inaczej tak zwana aplikacja, zawiera tysiące linijek kodu napisanych w danym języku programowania, na przykład w Javie, C++ itp. Kod tworzony przez programistów ma ściśle określony cykl życia. Przede wszystkim aplikacja musi zostać poprawnie zaprojektowana przez analityków, którzy uwzględnią jej funkcjonalność, jak i sposób zakodowania. Powstaje wówczas ogólna koncepcja programu. Tworzone są diagramy UML, które obrazują klasy występujące w kodzie programu, niejako schemat logiki aplikacji. W następnej fazie produkcji oprogramowania programiści kodują aplikację z wytycznymi. W trakcie ich pracy lub pod koniec przeprowadzane są testy aplikacji, czy spełnia wszystkie wymagania pod względem formalnym, funkcjonalnym i czy odpowiada na oczekiwania klienta. Podczas całego procesu wytwarzania oprogramowania powstaje odpowiednia dokumentacja. W skład dokumentacji aplikacji wchodzi między innymi dokumentacja dla użytkownika końcowego.
Co zawiera dokumentacja dla użytkownika?
Dokumentacja użytkownika składa się zazwyczaj z ogólnych opisów oraz rysunków służących obsłudze, pomocy oraz konfiguracji danej aplikacji. Dokumentacja użytkownika ma wyjaśnić użytkownikowi nietechnicznemu obsługę takiej aplikacji w sposób jak najmniej branżowy, zrozumiały dla kogoś spoza branży. Taka dokumentacja w Polsce najczęściej powstaje w języku polskim i języku angielskim jako języku międzynarodowym. Dokumentacja ma pomóc w wykonywaniu możliwych w programie operacji, jest to niejako instrukcja podobna do instrukcji obsługi pralki. Osoba z zewnątrz może korzystać z niej na swoje własne potrzeby, nie wgłębiając się w logikę i skomplikowany kod. Wystarczy do jej obsługi zazwyczaj GUI, czyli interfejs użytkownika.
Jakie są dokumentacje oprócz dokumentacji użytkownika?
Oprócz wspomnianej już dokumentacji użytkownika tworzy się również dokumentację techniczną, która zawiera kod programu i logikę aplikacji. Taka dokumentacja jest przeznaczona głównie dla programistów.
Wszystkich, którzy potrzebują indywidualnie dopasowanego do swoich potrzeb oprogramowania, zapraszamy na stronę internetową https://boss.net.pl/. Znajdziecie tam także cenne wskazówki dotyczące wdrożenia i innych ważnych aspektów programistycznych.