Deep dive: Jak VLO Space pisze raporty?

CanSat to konkurs którego znaczna część polega na drużynowym pisaniu raportów. Każdy, kto w kilka osób pisał dowolny dokument wie jednak, że często wiąże się to ze znaczną ilością bałaganu.

Czy w szkole, czy w pracy, trudno zmusić współpracowników do stosowania identycznego stylu i rozmiaru czcionek, obrazków, tabel, diagramów oraz ich opisów. Ma to szczególne znaczenie przy pisaniu technicznych dokumentów, gdzie czytelność takich elementów jest podstawą zrozumienia tekstu.

W zeszłym roku pisaliśmy nasze raporty na platformie Google Docs. Rozwiązanie to wybraliśmy głównie dla możliwości równoległej pracy nad różnymi częściami dokumentu.

Osoby bardziej zaznajomione z pisaniem technicznych dokumentów znają popularne rozwiązanie stosowane w kręgach naukowych. LaTeX to system w którym zamiast pisać tekst w graficznym środowisku, pisze się specjalny kod, który oprócz samej zawartości opisuje również jak dokument ma wygądać.

LaTeX jest systemem w którym łatwiej jest utrzymać porządek w stylu dokumentu. Taki sposób pracy ma jednak swoje wady - LaTeX to program który rozwijał się przez ostatnie 41 lat, a co za tym idzie - nie jest zbyt nowoczesny czy szybki. Z tego powodu użytkownicy LaTeXa również często nie mają podglądu na żywo podczas pisania dokumentu.

Drugim problemem jest przystępność - osobom z doświadczeniem programistycznym względnie łatwo jest zrozumieć taki system, ale członkom drużyny odpowiadającym za inne aspekty projektu mogłoby być trudno go zaadoptować.

Frustracja wynikająca z tych problemów jest genezą nowego narzędzia - Typst’a. Ma ono być szybsze, oraz bardziej intuicyjne niż jego poprzednicy.

Gdy na początku tej edycji pokazałem Typst’a reszcie drużyny, reakcja nie była szczególne entuzjastyczna. Główną obawą była trudność nauki nowego systemu. Jednak w obecnym momencie projektu nawet najmniej zaznajomieni z softwarem członkowie dużyny potrafią z niego korzystać.

Korzyści ze zmiany systemu nie kończą się jednak na ujednoliceniu stylów. Dzięki Typst’owi numery figur, tabeli i diagramów są automatycznie aktualizowane w tekście, diagramy są napisane bezpośrednio w dokumencie, a nawet okładka naszego raportu została wykonana bez użycia zewnętrznych programów graficznych.

Choć Typst zdecydowanie nie jest systemem dla wszystkich, dla nas okazał się on być właściwym rozwiązaniem, które znacznie poprawiło jakość prezentacji naszego raportu. W ramach konkrusu CanSat aspekty techniczne pojawiają się nie tylko przy projektowaniu i wykonywaniu samej sondy, ale również przy rzeczach, które wydają się być względnie mało znaczące.