Koji alat koristite za izradu dokumentacije

Pozdrav,

naslov skoro sve kaže…znači tražim online alat za izradu dokumentacije. Od alata se očekuje da je praktičan:

  1. Sa aspekta izrade dokumentacije
    Da se dokumenti jednostavno izrađuju, da postoje kvalitetni templatei koji će olakšati izradu, ali i učiniti rezultat vizualno pregledan/dopadljiv.

  2. Sa aspekta timskog rada.
    Znači da alat omogućuje da više ljudi može surađivati na izradi sa vlastitim korisničkim računima.

Bilo bi super i da je besplatan, ako postoji takvo nešto uopće?
Veliki plus ide i za jednostavnost korištenja.

Slobodno pohvalite ono što vi koristite?

Mislim da trebamo malo više informacija :smiley:

O kakvoj izradi dokumentacije je riječ ?

GitBook

https://www.gitbook.com/

ApiDoc za (REST) API.

Hvala na ovim tipovima, pročačkat ću.

Možda u prvu ruku bi se na dokumentaciju moglo gledati i kao na obične članke…znači da se mogu pisati upute bilo kakvog tipa. Tipa, želi se napisati dokumentacija klijentu kako će koristiti software. Naravno, da je to sve fino posloženo, kako bi ličilo na dokumentaciju.

Nadalje, ne mislim da bi alat služio samo za “članke/dokumente”, nego da ima podršku i za pisanje dokumentacije za programski code. Tu bi sigurno nekakvi templatei pomogli da se stvari mogu lijepo prikazati, a na jednostavan način izradit.

Nadalje…nebi bilo loše da ima podršku i za izradu vlastitih templatea…

Ovo što sam spomenuo aspekt timskog rada…tu sporazumjevam da vlasnik dokumentacije može dodjeliti nekakve uloge drugim korisnicima, da isti mogu dodavati/editirati dokumente.

Pa nebi bilo loše da dokumenti imaju i nekakvu mogućnost komentiranja…globalno dokumenta ili pojedinih djelova…

Pa nebi bilo loše da prilikom ažuriranja dokumenta, dobiju notifikaciju oni koji “prate” taj dokument.

To ovako na ćoravo vidim što bi moglo trebati…sigurno da bi još puno zahtjeva iskočilo. :smiley:
Vjerujem da oni koji se bave razvojem ovakvih alata…su već doskočili zahtjevima koji će mi tek zatrebati…

Treba ti neki document management sustav koji je socijalan i dinamičan.

Tvoj problem je:
Dokument = Statično, asocijalno
Ti želiš = Dinamično, socijalno

Za stvaranje statičnog dokumenta, lagano je koristiti neki library npr. itext za Javu (github mi na search “pdf” za Javu daje 5824 repozitorija), no tebi treba nešto dinamično.

Alternativno, netko ti može isprogramirati tanak socijalan sloj oko dokumenata poput onih na Google Docsu. Issue/Bug tracker također nebi bio loš (JIRA je najpoznatija, nije besplatna ali postoje besplatne alternative). Napraviš issue, zakačiš dokument, ljudi se pretplate na issue, mogu komentirati, ako se nešto promijeni budu obaviješteni i sl.


Copyright © 2020 WM Forum - AboutContact - Sponsored by: Mydataknox & Profit Monkey