Један од најважнијих задатака при креирању софтвера је документација, нажалост за нас који развијамо ово дело, понекад се чини заморно, али никоме није тајна да добра документација може бити тачка успеха било ког алата, јер било за помоћ која се даје корисницима да разумеју исправан рад апликације или информације које се пружају другим програмерима да би је побољшали.
Постоје прилично добре апликације које нам омогућавају да своје пројекте документујемо на једноставан начин, неки имају тенденцију да понуде више од онога што заиста желимо, а други захтевају сложене инсталације, алат за документовање пројеката који је у складу и прилично је једноставан за употребу и инсталирање је Доцусаурус.
Шта је Докусаурус?
Докусаурус је пројекат за изградити, применити и одржавати веб документацију алата отвореног кода, омогућава употребу језика Маркдовн Да бисмо на исти начин написали документацију која ће касније бити објављена као хтмл веб локација, алат нам омогућава да проширимо и прилагодимо дизајн наше веб странице са документацијом помоћу Реацт-а.
Генерално, овај алат отвореног кода који је развио Фацебоок тим за програмирање омогућава нам да лако креирамо лепе и лагане веб странице на којима можемо правилно приказати документацију било ког пројекта.
Алат је опремљен функционалностима за исправно обликовање верзија докумената, напредним претраживачем, могућношћу документовања и редизајнирања наше документационе странице у реалном времену, интеграцијом са преводима и многим другим функцијама које ће вам помоћи да се мање бринете око документовања или, пре, за прављење поступак документације лакши и пријатнијег завршетка.
Лако коришћење Доцусауруса може се видети на следећем гифу који су дистрибуирали његови програмери
Како инсталирати Доцусаурус?
Главни циљ Доцусауруса је да буде коначни алат за документовање апликација отвореног кода хостованих на гитхуб-у, тако да је заиста лако инсталирати и покренути вашу веб локацију за документацију на овој платформи.
Да бисте почели уживати у Доцусаурусу на Гитхуб-у, само следите кораке које је назначио развојни тим и које цитирамо у наставку:
- Идите у корен свог директоријума спремишта ГитХуб где ћете креирати документе и покренути следеће команде:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Крајњи резултат биће стварање датотеке и структуре директорија као што је приказано доле:
Занимљива грешка за испробавање!