Niezależnie od tego, czy projekt publikowany jest szerszej grupie osób, czy tylko pracownikom jednej firmy, przydaje się strona WWW, na której można znaleźć szczegóły techniczne programu bądź biblioteki. Strona taka powinna zawierać dokumentację kodu (JavaDoc), wyniki testów, sposób użycia biblioteki, informacje ...
Więcej…
Po omówieniu struktury dokumentów, nadszedł czas na bardziej zaawansowane wykorzystanie zdobytej wiedzy.
Najpierw utworzę podstawowy plik raportu, zawierającego dokumentację projektu (dokumentacja.tex):
\documentclass[a4paper,11pt]{report}
\usepackage[utf8]{inputenc}
\usepackage{polski}
\begin{document}
\chapter{Wymagania}
\input{wymagania}
\chapter{Instrukcja}
\input{instrukcja}
\end{document}
Znacznik \input służy włączaniu fragmentów znajdujących się w innych plikach do dokumentu. Przykładowo \input{wymagania} ...
Więcej…
Dzisiaj postanowiłem zrobić małą przerwę w omawianiu JBoss Seam i powrócić do tematu LATEX-a oraz sporządzania dokumentacji projektu. Opisałem już pierwszy projekt w LATEX-u, lecz typowy dokument ma jakąś strukturę, wyznaczoną przez nagłówki. Odpowiednio zdefiniowane fragmenty tekstu zwiększają czytelność i przyspieszają wyszukiwanie określonych informacji.
Standardowe ...
Więcej…
Skoro już zainstalowałem LATEX-a, przyszła pora na pierwszy dokument – niech zaiwera tekst: „Hello LATEX”.
Tworzę nowy pusty plik – powiedzmy hello.tex – i otwieram go w edytorze teksotwym. Najpierw muszę zdefiniować klasę (typ) dokumentu – standardowo dostępne są cztery podstawowe: artykuł, raport, ...
Więcej…
