Előbb-utóbb minden fejlesztőnek megakad egy kicsit a torkán az a kérdés, hogy valamilyen sármos formában, de mégsem túl sok erőforrást igénybe véve dokumentálni illene a projektet. Persze van a kis arculat, írjuk meg Word-ben, esetleg csináljunk belőle pdf-et és hadd szóljon. Ez is megoldás, de mutatok valami mást.
A Documenter - immár v2 - online szerkesztési felületet ad a fent leírt, kisebb-nagyobb doksik elkészítésére. Egyszer kialakítod a projekthez, vagy magadhoz az arculatot, és valami elképesztő sebességgel elő tud állni egy olyan html doksi, amit aztán csatolhatsz az install csomag mellé.
Ide kell ellátogatni egy próbáért: http://revaxarts-themes.com/documenter/. Próbából töltsd le az eszköz saját dokumentációját, amit nyilván ugyanezzel az eszközzel készítettek. Klikk fent a Documenter doc buttonra, aztán lent a Build document ellőállítja a doksit a paramétereknek megfelelően akár Twitter Bootstrap stílusban is. Vagy nézz meg egy kész anyagot itt: http://revaxarts-themes.com/documenter/docs/
Erről eszembe is jutott, hogy anno írtam egy forráskód editort. Mikor már elég szépen működött, a saját forrását is azzal szerkesztettem. Soha nem feledhető élmény. :)
Utolsó kommentek