Archiwum wpisów dla słowa kluczowego „Dokumentacja”


Marzec
10
2010

Strona wtyczki Maven

Słowa kluczowe: , , , , | Kategorie: Java
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…
Marzec
03
2010

Diagramy Dia w dokumencie LaTeX

Słowa kluczowe: , , , , , , | Kategorie: TeX i LaTeX
Gdy już planowałem utworzenie dokumentacji projektu w LATEX z wykorzystaniem Apache Maven i opisanej ostatnio wtyczki, pomyślałem o umieszczeniu w dokumencie diagramów UML czy BPMN. Cel ten mogłem zrealizować na kilka sposobów. Najprościej byłoby eksportować diagramy do obrazków (na przykład PNG), a następnie osadzać je w dokumencie. Jednak za wszelką cenę ... Więcej…
Marzec
02
2010

LaTeX i Maven2

Słowa kluczowe: , , , | Kategorie: TeX i LaTeX
Serię artykułów związanych z Apache Maven zaczynam od tematu, który być może powinien pojawić się dużo później. Jednak ukończyłem właśnie pracę nad projektem, który wiąże się bezpośrednio z tym zagadnieniem i w najbliższym czasie chciałbym napisać więcej na ten temat. Tworzenie dokumentacji z wykorzystaniem kompilatora LATEX ... Więcej…
Sierpień
26
2009

Działające oprogramowanie vs. dokładna dokumentacja

Słowa kluczowe: , | Kategorie: Metodyki zwinne
Teraz pora omówić najtrudniejszą dla mnie regułę zawartą w manifeście zwinności. Co w niej trudnego? Właściwie wszystko jest oczywiste – towarem, jaki dostarcza się klientom jest program komputerowy, a nie dokumentacja techniczna, na podstawie której można ten program napisać. Zatem działające oprogramowanie ma ... Więcej…
Sierpień
24
2009

Manifest zwinności

Słowa kluczowe: , | Kategorie: Metodyki zwinne
Sezon wakacyjny jeszcze się nie skończył, więc zamiast kontynuować główne wątki, poświęcę trochę czasu metodom rozwijania projektów programistycznych. Skupię się szczególnie na metodykach zwinnych – niedocenianych przez jednych i znacznie przecenianych przez innych. Zanim przejdę do sedna zagadnienia przeanalizuję dokładnie podstawowe zasady ... Więcej…