Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Solution for web documentation
#1
Does anyone know of some software to easily manage docs and tutorials.
Steps, screenshots , figures etc , FAQ?

Webbased or node etc.
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#2
Why not a Wiki?

e.g. DokuWiki was devolped for this kind of usage.
Reply
#3
Nowadays I use Google presentation software for this purpose.

Allthough This is the making of the docs itself, not really the managing.
Reply
#4
yeah a wiki is a bit overkill, and not really what i need.
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#5
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 :-)
Reply
#6
I have not chosen anything yet.
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#7
Maybe Draft
Reply
#8
Guide on the Side:
https://github.com/ualibraries/Guide-on-the-Side
Reply
#9
very very cool, thanks
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#10
Where do you need it for by the way?
Reply
#11
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.
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#12
I also recently found Visme, can also be used for that:
http://www.visme.co/

Maybe a bit over the top..
Reply
#13
(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.
Reply
#14
great suggestions, thanks
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#15
Not realy a system, but maybe can be used in a system in some way:
http://usablica.github.io/intro.js/
Reply
#16
It seams you can use Doxygen for normal documentation
Reply
#17
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)
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#18
(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
Reply
#19
neato

I use sublime text with docblockr, which is pretty much the same thing.
Uses pretty much the same syntax.
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#20
Did you know about this site:
https://readthedocs.org/
Reply
#21
Just found this documentation generator: http://daux.io/
Reply
#22
Very nice
NEW: SA Admin Toolbar Plugin | View All My Plugins
- Shawn A aka Tablatronix
Reply
#23
And another one...
https://www.gitbook.com/
Reply




Users browsing this thread: 1 Guest(s)
Free HDTV Channels Residential Solar Panels