Zadejte hledaný výraz...

Ako na dokumentaciu projektu?

node
verified
rating uzivatele
(5 hodnocení)
9. 11. 2016 15:25:38
Ahojte,
potrebujem napisat dokumentaciu k obshialemu php projektu. Nemam na mysli dokumentaicu kodu ale skor ako aplikacia funguje, sem-tam nejaky kusok kodu ako priklad, popis infrastrukturi/hw/sluzieb a podobne. Skratka taky overview pre vyvojarov a ludi co s tym budu pracovat a spravovat to(vyvoj/udrzba).
Ktory projekt" je teraz taky najpopularejsi?
Ide mi hlavne o jendoduchost a mozno by bolo dobre mat aj podporu verzii. Osobne sa mi najviac paci dokumentacia pre Stripe ale vyzera to byt vlastne riesenie. Mnoho ludi pouziva Sphinx ale nejak ma to nelaka.
Asi by som si to predstavoval tak ze by som mal nejaku jednoduchu strukturu zloziek s markdown subormi a nejake funkcne prelinkovanie s podporou stromovej sturktury. Cize ziaden komplikovany builder ani nic podobne....
Bral by som keby som nieco take mohol spravit v Google docs ale z praxe to nie je ono.
9. 11. 2016 15:25:38
https://webtrh.cz/diskuse/ako-na-dokumentaciu-projektu/#reply1236156
TomasX
verified
rating uzivatele
(4 hodnocení)
9. 11. 2016 17:47:56
až na vyjímky dokumentace k projektům dělám v jednotkách dokumentů ve wordu, usnadníš tím sdílení i správu. Struktura dokumentu je jeho obsah a kapitoli, nemusíš z toho dělat složky a dokumenty.
Něco jiného je dokumentace k API, na kterou je nejlepší používat nějaký generátor a výstup v čistém html je opěr nejvíce přenosný.
9. 11. 2016 17:47:56
https://webtrh.cz/diskuse/ako-na-dokumentaciu-projektu/#reply1236155
node
verified
rating uzivatele
(5 hodnocení)
9. 11. 2016 17:55:03
Rozmyslam ze by som v konecnom dosledku spravil jeden dlhy markdown subor. Akurat by som bral keby bola moznost mat, ako v tom stripe, vlavo osnovu a v pravo code snippety.
9. 11. 2016 17:55:03
https://webtrh.cz/diskuse/ako-na-dokumentaciu-projektu/#reply1236154
TomasX
verified
rating uzivatele
(4 hodnocení)
9. 11. 2016 17:59:58
podle mě v popisu architektury/služeb/hw není tolik zdrojáků potřeba, stejně to bude jen povídání, kterých jsou všude miliony.
Osobně mám nejraději podobné věci v pdf, lépe se mi to čte, spravuje a hledá v tom, dělat to ve webové dynamické aplikaci mi připadá zbytečná překážka.
9. 11. 2016 17:59:58
https://webtrh.cz/diskuse/ako-na-dokumentaciu-projektu/#reply1236153
Pro odpověď se přihlašte.
Přihlásit