Dokumentacja programu w C++

dav123
Użytkownik
Użytkownik
Posty: 20
Rejestracja: 3 lip 2013, o 18:22
Płeć: Mężczyzna
Lokalizacja: Lokalizacja
Podziękował: 16 razy

Dokumentacja programu w C++

Post autor: dav123 »

Co to jest dokumentacja? Jak wygląda dokumentacja, obejmująca: manual, diagram klas, oraz specyfikację danych wejściowych i wyjściowych oraz
przykładowe dane wejściowe ?

Dokumentację mam dołączyć wraz z kodem źródłowym(grą w warcaby).

PS. Potrzebuję to wiedzieć na teraz, więc jak możecie,to nie zwlekajcie z odpowiedzią.
Ostatnio zmieniony 4 wrz 2013, o 15:48 przez Afish, łącznie zmieniany 1 raz.
Powód: Staraj się lepiej dobierać nazwy tematów, tak by wskazywały o czym jest treść zadania.
bartek118
Użytkownik
Użytkownik
Posty: 5974
Rejestracja: 28 lut 2010, o 19:45
Płeć: Mężczyzna
Lokalizacja: Toruń
Podziękował: 15 razy
Pomógł: 1251 razy

Dokumentacja programu w C++

Post autor: bartek118 »

Nie ma nigdzie podanych ścisłych reguł.

Przede wszystkim powinna zawierać na start
- opis wykorzystanych technologii, bibliotek i przede wszystkim autora
- opis oprogramowania - co jest, do czego służy, na jaki system, wymagania systemowe i sprzętowe itp
- krótka instrukcja/przewodnik z kilkoma screenami,
- diagram klas
- opis poszczególnych klas i wszystkich ich metod i pól
- opis algorytmów wykorzystywanych w realizacji poszczególnych zadań
- jeżeli korzystałeś ze wzorców projektowych, to powinieneś na końcu zawrzeć z jakich i które klasy odgrywają jaką rolę w danym wzorcu-- 3 wrz 2013, o 17:53 --
bartek118 pisze:Nie ma nigdzie podanych ścisłych reguł.

Przede wszystkim powinna zawierać na start
- opis wykorzystanych technologii, bibliotek i przede wszystkim autora
- opis oprogramowania - co jest, do czego służy, na jaki system, wymagania systemowe i sprzętowe itp
- krótka instrukcja/przewodnik z kilkoma screenami,
- diagram klas
- opis poszczególnych klas i wszystkich ich metod i pól
- opis algorytmów wykorzystywanych w realizacji poszczególnych zadań
- jeżeli korzystałeś ze wzorców projektowych, to powinieneś na końcu zawrzeć z jakich i które klasy odgrywają jaką rolę w danym wzorcu
No i zapomniałem - oczywiście specyfikację wejścia i wyjścia, jeśli takowe są.
dav123
Użytkownik
Użytkownik
Posty: 20
Rejestracja: 3 lip 2013, o 18:22
Płeć: Mężczyzna
Lokalizacja: Lokalizacja
Podziękował: 16 razy

Dokumentacja programu w C++

Post autor: dav123 »

A co to są te diagramy klas? Są to po prostu klasy np. które dziedziczą, albo zawierają polimorfizm?
Gdzie taką dokumentację się pisze? Na samym początku w oknie konsoli?

Co to jest ta specyfikacja wejscia/wyjscia?
przykładowe dane wejsciowe to np. kilka początkowych ruchów graczy??
bartek118
Użytkownik
Użytkownik
Posty: 5974
Rejestracja: 28 lut 2010, o 19:45
Płeć: Mężczyzna
Lokalizacja: Toruń
Podziękował: 15 razy
Pomógł: 1251 razy

Dokumentacja programu w C++

Post autor: bartek118 »

Dokumentację piszesz przeważnie w Wordzie lub w LaTeX-u i zapisujesz do pdfa.
Co do specyfikacji we/wy - zależy od tego, jaki masz program.
Co do diagramu klas - zerknij tutaj:
dav123
Użytkownik
Użytkownik
Posty: 20
Rejestracja: 3 lip 2013, o 18:22
Płeć: Mężczyzna
Lokalizacja: Lokalizacja
Podziękował: 16 razy

Dokumentacja programu w C++

Post autor: dav123 »

no np. mam program który chce zeby podać mu imiona dwóch graczy , którzy będą grać w warcaby. I te przykładowe dane wejściowe to imie gracza pierwszego, drugiego i np., kilka początkowych ich ruchów w grze w warcaby? W necie pisze że dane wejściowe to to co podaje się w konsoli jak program chce, ale nie jestem pewny czy tu o to chodzi bo po co komu byłyby takie przykładowe dane wejsciowe ;/
Ser Cubus
Użytkownik
Użytkownik
Posty: 1406
Rejestracja: 6 maja 2012, o 22:46
Płeć: Mężczyzna
Lokalizacja: Polska
Podziękował: 107 razy
Pomógł: 145 razy

Dokumentacja programu w C++

Post autor: Ser Cubus »

więc poprostu opisz do czego używane są dane wejściowe
dexter90
Użytkownik
Użytkownik
Posty: 391
Rejestracja: 11 lis 2011, o 09:48
Płeć: Mężczyzna
Pomógł: 32 razy

Dokumentacja programu w C++

Post autor: dexter90 »

Nikt z was tu nie napisał autorowi, że należy rozróżnić dokumentację techniczną oraz użytkownika. To dwa, zupełnie inne twory kierowane do różnych grup...
bartek118
Użytkownik
Użytkownik
Posty: 5974
Rejestracja: 28 lut 2010, o 19:45
Płeć: Mężczyzna
Lokalizacja: Toruń
Podziękował: 15 razy
Pomógł: 1251 razy

Dokumentacja programu w C++

Post autor: bartek118 »

dexter90 pisze:Nikt z was tu nie napisał autorowi, że należy rozróżnić dokumentację techniczną oraz użytkownika. To dwa, zupełnie inne twory kierowane do różnych grup...
Zgadza się, ale z postu autora wynika, że chodzi o dokumentację techniczną. Jeśli o dane wejściowe/wyjściowe, jak najbardziej powinny być w takiej omówione. Na inżynierii oprogramowania uczono mnie także, że dokumentacja techniczna, mimo że jest techniczna, powinna zawierać na początku opis interfejsu i skrót/wyciąg z instrukcji dla użytkownika.
dexter90
Użytkownik
Użytkownik
Posty: 391
Rejestracja: 11 lis 2011, o 09:48
Płeć: Mężczyzna
Pomógł: 32 razy

Dokumentacja programu w C++

Post autor: dexter90 »

Kod: Zaznacz cały

Jeśli o dane wejściowe/wyjściowe
Zgadza się.

Kod: Zaznacz cały

na początku opis interfejsu i skrót/wyciąg z instrukcji dla użytkownika
Spotykałem się z takimi dokumentacjami. Jednakże życie pokazuje że często gęsto jest inaczej. Na początku dokumentacji technicznej warto opisać całą wielowarstwową architekturę aplikacji ( jeżeli takowa architektura istnieje ). Na początku można zawrzeć warstwę użytkownika, niżej warstwy integracyjne ( po drodze np. szyny ESB ), a na samym dole np. warstwę bazy danych. Z jakich protokołów korzysta aplikacja ( np. w jaki sposób realizowane są WebServicy - np. opisać WSDL, SOAP ). To moim zdaniem idealny początek dokumentacji technicznej. Takiej rasowej. Niżej można opisać konwencje nazw oraz ogólnie przyjęte zasady podczas pisania aplikacji. Dalej, metody i słowniki.

Na uparciucha można coś też dać jak piszesz.
ODPOWIEDZ