TeX i dokumentacja projektu
Każdy, kto pracował nad projektem większym niż „Hello World”, przekonał się, że sporządzanie mniej lub bardziej szczegółowej dokumentacji jest konieczne – niezależnie od przyjętej metodyki. Dzisiaj chciałbym się zająć wyborem narzędzia, które pozwoli stworzyć przejrzysty i uporządkowany dokument.
Gdy w firmie powstaje potrzeba utworzenia szczegółowej dokumentacji, pierwszą propozycją jest: Napiszmy to w… i tutaj pada nazwa jednego z popularnych edytorów typu WYSIWYG. Moim zdaniem jest to najgorszy pomysł z możliwych. Znane mi środowiska tego typu zużywają wiele zasobów komputera – szczególnie dla dużych dokumentów z dużą ilością grafiki. Pominę już bałagan, jakim grozi użycie „intuicyjnego interfejsu użytkownika”.
Dużo lepszym pomysłem jest wykorzystanie języka HTML – dokumentacja jest podzielona na strony, zawierające jedynie informacje na wybrany temat. Aby ułatwić edycję i kategoryzację artykułów, użyłbym jednego z wielu darmowych środowisk typu wiki. Taka dokumentacja będzie uporządkowana, przejrzysta, szybka i stabilna w działaniu, ale szalenie kłopotliwa w druku.
Zatem czego należałoby używać? Osobiście polecam procesor tekstu, taki jak TEX. O jego zaletach przekonałem się pisząc pracę magisterską – edycja pliku .doc zawierającego sto stron i kilkadziesiąt obrazków była po prostu niemożliwa, podczas gdy TEX nie miał z nim żadnych problemów.
W najbliższym czasie opiszę kilka podstawowych zagadnień związanych z TEX-em. Oczywiście nie zapomnę przy tym o JBoss Seam.
