Układ typograficzny pracy inżynierskiej: rysunki, schematy i kod źródłowy
Praca inżynierska zawiera elementy, których standardowe zasady redakcji tekstu nie rozwiązują: schematy, kod, równania, rysunki techniczne i dokumentację projektu. Układ musi zachować czytelność na ekranie, w druku oraz po konwersji do PDF.
Najważniejsze informacje
- ✓Projektuj elementy z myślą o docelowym formacie strony.
- ✓Numeruj i przywołuj każdy rysunek, schemat oraz listing.
- ✓Kod źródłowy formatuj konsekwentnie i pokazuj tylko potrzebne fragmenty.
- ✓Obszerne materiały przenoś do załączników.
Rysunki i schematy
Eksportuj diagramy w jakości zapewniającej czytelność linii i opisów po zmniejszeniu. Ujednolić trzeba krój pisma, grubość linii, symbole oraz nazewnictwo. Każdy element powinien mieć podpis, źródło i odwołanie w tekście.
Listingi kodu
Stosuj czcionkę o stałej szerokości, numerację wierszy tylko wtedy, gdy jest przydatna, oraz kontrolowane łamanie długich linii. Fragment kodu musi być omówiony: czytelnik powinien wiedzieć, jaką funkcję realizuje i dlaczego został pokazany.
Równania i oznaczenia
Wprowadź listę symboli, jeśli oznaczeń jest wiele. Równania numeruj konsekwentnie i objaśniaj zmienne bezpośrednio po ich pierwszym użyciu. Nie wstawiaj wzorów jako niskiej jakości obrazów, jeśli edytor równań pozwala zachować poprawną typografię.
Strony poziome i PDF
Duże schematy można umieścić w osobnej sekcji o orientacji poziomej, kontrolując nagłówki i numerację. Po eksporcie sprawdź osadzenie czcionek, jakość grafik, odsyłacze oraz to, czy elementy nie wychodzą poza margines przeznaczony na oprawę.
Podsumowanie
Spójny układ techniczny pozwala ocenić projekt bez walki z przypadkową skalą rysunków i niespójnymi listingami. Najpierw trzeba ustalić system elementów, a następnie stosować go konsekwentnie w całym dokumencie.
Najczęściej zadawane pytania
Czy cały kod programu powinien znaleźć się w pracy?
Zwykle w tekście głównym pokazuje się fragmenty istotne dla wyjaśnienia rozwiązania. Pełny kod można przekazać w repozytorium lub załączniku zgodnie z zasadami uczelni.
Potrzebujesz wsparcia przy swojej pracy?
Opisz temat, zakres i termin. Sprawdzimy materiały, podpowiemy właściwy zakres pomocy i przygotujemy przejrzystą wycenę.
