+- GetSimple Support Forum (http://get-simple.info/forums)
+-- Forum: GetSimple (http://get-simple.info/forums/forumdisplay.php?fid=3)
+--- Forum: Off Topic (http://get-simple.info/forums/forumdisplay.php?fid=12)
+--- Thread: Solution for web documentation (/showthread.php?tid=6683)
Solution for web documentation - shawn_a - 2014-08-26
Does anyone know of some software to easily manage docs and tutorials.
Steps, screenshots , figures etc , FAQ?
Webbased or node etc.
RE: Solution for web documentation - Lars - 2014-08-26
Why not a Wiki?
e.g. DokuWiki was devolped for this kind of usage.
RE: Solution for web documentation - datiswous - 2014-08-28
Nowadays I use Google presentation software for this purpose.
Allthough This is the making of the docs itself, not really the managing.
RE: Solution for web documentation - shawn_a - 2014-08-29
yeah a wiki is a bit overkill, and not really what i need.
RE: Solution for web documentation - Lars - 2014-08-29
Hmm. Overkill? A Doku-Wiki! Set up in minutes up and running in less an hour... details UAC, no database, simple Syntax, easy links and media... running an a stick with micro apache ....
OK, I thought it would be a great idea ;-)
Tell us what you have chosen, im very intrested in :-)
RE: Solution for web documentation - shawn_a - 2014-08-29
I have not chosen anything yet.
RE: Solution for web documentation - datiswous - 2014-12-03
Maybe Draft
RE: Solution for web documentation - datiswous - 2014-12-12
Guide on the Side:
https://github.com/ualibraries/Guide-on-the-Side
RE: Solution for web documentation - shawn_a - 2014-12-12
very very cool, thanks
RE: Solution for web documentation - datiswous - 2014-12-12
Where do you need it for by the way?
RE: Solution for web documentation - shawn_a - 2014-12-12
For work, I need a way to manage screenshots, annotate, add as figures, create step by step directions, and doing it in word sucks.
I love to just have it as data
step 1, desc, attach images, insert figure here, link etc.
RE: Solution for web documentation - datiswous - 2014-12-12
I also recently found Visme, can also be used for that:
http://www.visme.co/
Maybe a bit over the top..
RE: Solution for web documentation - hameau - 2014-12-15
(2014-12-12, 08:02:58)shawn_a Wrote: For work, I need a way to manage screenshots, annotate, add as figures, create step by step directions, and doing it in word sucks.
Depending on your complexity, perhaps Zim would work for you.
Lightweight, text files based (easy backup, easy search), export to html (custom templates, whole notebook or single page, with or without child pages). Lots of plugins for extra features.
I have used it for several years on the desktop for note-taking and as a, well, personal wiki, I suppose.
RE: Solution for web documentation - shawn_a - 2014-12-15
great suggestions, thanks
RE: Solution for web documentation - datiswous - 2014-12-17
Not realy a system, but maybe can be used in a system in some way:
http://usablica.github.io/intro.js/
RE: Solution for web documentation - datiswous - 2015-01-23
It seams you can use Doxygen for normal documentation
RE: Solution for web documentation - shawn_a - 2015-01-23
Not what i was looking for but this is awesome, i have been fiddling with phpdoc to try to get our source cleaned up and documented better than the wiki.
This is just perfect for that, how did I not know about that. ( they even have win binaries!, so i can run this on anything)
RE: Solution for web documentation - datiswous - 2015-01-23
(2015-01-23, 12:12:00)shawn_a Wrote: Not what i was looking for but this is awesome, i have been fiddling with phpdoc to try to get our source cleaned up and documented better than the wiki.Glad to be of help. Maybe these extensions are handy as well:
This is just perfect for that, how did I not know about that. ( they even have win binaries!, so i can run this on anything)
https://github.com/avleze/brackets-doxygen
https://github.com/dail8859/DoxyIt
RE: Solution for web documentation - shawn_a - 2015-01-24
neato
I use sublime text with docblockr, which is pretty much the same thing.
Uses pretty much the same syntax.
RE: Solution for web documentation - datiswous - 2015-03-13
Did you know about this site:
https://readthedocs.org/
RE: Solution for web documentation - datiswous - 2016-09-06
Just found this documentation generator: http://daux.io/
RE: Solution for web documentation - shawn_a - 2016-09-06
Very nice
RE: Solution for web documentation - datiswous - 2017-02-03
And another one...
https://www.gitbook.com/