Tak to jest jak się bierze za takie prace na ostatnią chwilę. Nie znam się na budownictwie, ale może nakieruję Cię, gdy Ci mniej więcej powiem jak ja piszę dokumentację projektów z programowania.
Ogólnie Twój plan to taki mój dokument projektowy, który tworzy się przed przystąpieniem do tworzenia programu, a zawiera on mniej więcej
1.Tytuł (standard ![:D]()
)
2.Analiza problemu (opis mniej więcej co program ma robić)
3.Specyfikacja zewnętrzna (opis UI, interakcji użytkownika z programem i take tam ![:D]()
)
4.Specyfikacja wewnętrzna:
Struktura programu (w przypadku np C++, Java, czy innych obiektowych języków programowania trzeba tu opisać najważniejsze klasy oraz hierarchię klas, co po czym dziedziczy i inne takie gówna)
algorytmy(opis algorytmów jakie zastosuję w programie).
5.Plan pracy (czyli tutaj planuję sobie co i kiedy będę implementować).
Jeszcze zanim przystąpię do pisania dokumentu projektowego projektuję program na kartce, rozrysowuję diagram klas, zastanawiam się jak je rozplanować. Opracowuję algorytmy (taki pseudokod), dokonuję kilku obliczeń, aby sprawdzić, czy to co planuję ma sens i jest optymalne, a dopiero potem przystępuję do pisania specyfikacji.
Dokumentacja jest o wiele obszerniejsza, ponieważ zawiera szczegółowe opisy metod, zmiennych i innych takich rzeczy, które zostały stworzone ![:D]()
. Ja osobiście tworzę dokumentację w trakcie pisania projektu, powoduje to, że mój kod jest czysty, ponieważ nie zaśmiecam go obszernymi komentarzami (zostawiam jedynie odpowiedni odnośnik do dokumentacji, gdzie mogę przeczytać co dany fragment programu robi jak w jakiś sposób o tym zapomnę), a przede wszystkim stosuję odpowiednie nazewnictwo klas, zmiennych i metod, które piszę ![;)]()
.
Nie wiem, czy to Ci pomoże, ale możesz jakoś spróbować przenieść na Twoją płaszczyznę to co napisałem, może w jakiś sposób Cię to nakieruje. Nie wiem, jako budowlaniec na pewno zaczął bym od projektu(narysowanie obiektu pod budowę, obliczenie wielu rzeczy, jakiejś twardości, czy wytrzymałości materiału, nachylenia czegoś tam...nie wiem nie znam się na tym ![:D]()
). Zastanowił bym się nad materiałami, które wykorzystał bym do budowy i takie tam...uczysz się w takiej szkole to powinieneś lepiej wiedzieć ![;)]()
