Posts: 6,266
Threads: 181
Joined: Sep 2011
Does anyone know of some software to easily manage docs and tutorials.
Steps, screenshots , figures etc , FAQ?
Webbased or node etc.
Posts: 116
Threads: 8
Joined: Oct 2011
Why not a Wiki?
e.g. DokuWiki was devolped for this kind of usage.
Posts: 1,247
Threads: 82
Joined: Feb 2011
Nowadays I use Google presentation software for this purpose.
Allthough This is the making of the docs itself, not really the managing.
Posts: 6,266
Threads: 181
Joined: Sep 2011
yeah a wiki is a bit overkill, and not really what i need.
Posts: 116
Threads: 8
Joined: Oct 2011
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 :-)
Posts: 6,266
Threads: 181
Joined: Sep 2011
I have not chosen anything yet.
Posts: 1,247
Threads: 82
Joined: Feb 2011
Posts: 1,247
Threads: 82
Joined: Feb 2011
Posts: 6,266
Threads: 181
Joined: Sep 2011
Posts: 1,247
Threads: 82
Joined: Feb 2011
Where do you need it for by the way?
Posts: 6,266
Threads: 181
Joined: Sep 2011
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.
Posts: 1,247
Threads: 82
Joined: Feb 2011
2014-12-12, 08:20:56
(This post was last modified: 2014-12-12, 08:22:13 by datiswous.)
I also recently found Visme, can also be used for that:
http://www.visme.co/
Maybe a bit over the top..
Posts: 423
Threads: 15
Joined: Mar 2011
(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.
--
Nick.
Posts: 6,266
Threads: 181
Joined: Sep 2011
great suggestions, thanks
Posts: 1,247
Threads: 82
Joined: Feb 2011
Not realy a system, but maybe can be used in a system in some way:
http://usablica.github.io/intro.js/
Posts: 1,247
Threads: 82
Joined: Feb 2011
It seams you can use Doxygen for normal documentation
Posts: 6,266
Threads: 181
Joined: Sep 2011
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)
Posts: 1,247
Threads: 82
Joined: Feb 2011
2015-01-23, 21:58:09
(This post was last modified: 2015-01-23, 23:12:27 by datiswous.)
(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.
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) Glad to be of help. Maybe these extensions are handy as well:
https://github.com/avleze/brackets-doxygen
https://github.com/dail8859/DoxyIt
Posts: 6,266
Threads: 181
Joined: Sep 2011
neato
I use sublime text with docblockr, which is pretty much the same thing.
Uses pretty much the same syntax.
Posts: 1,247
Threads: 82
Joined: Feb 2011
Did you know about this site:
https://readthedocs.org/
Posts: 1,247
Threads: 82
Joined: Feb 2011
Just found this documentation generator: http://daux.io/
Posts: 6,266
Threads: 181
Joined: Sep 2011
Posts: 1,247
Threads: 82
Joined: Feb 2011
|