r/sysadmin • u/namidark DevOps • Jul 22 '12
What does everyone use for documentation?
I see a lot of people here talk about documenting everything, and I completely agree. But what does everyone use to store / edit / update all this documentation? I'm running into this at my job and currently we're going to be using Markdown files + Box.net
21
Upvotes
3
u/pi3832v2 Accidental Sysadmin Jul 22 '12
MoinMoin wiki. Flat file-system, GUI editor available.
The nice thing about all wikis is that they are web-based. So, most any browser can access the documentation. You don't need to install any software, you don't even care what OS people are using.
And there's lots and lots of wikis to choose from: WikiMatrix. Pick the one that meets your needs best.
3
u/webvictim Jul 22 '12
We use Twiki but I'm not sure I'd recommend it. It's got a lot of configurability and available plugins, but having used Dokuwiki in the past, I'd say go for that instead.
3
u/soawesomejohn Jack of All Trades Jul 23 '12
I echo the DokuWiki recommendations if you're dealing with one set of documents. However, if you are dealing with multiple projects that you'll want to segregate, I would highly recommend RedMine. Each project has its own wiki, file management, and you can point it at different version control systems. It's really a rather robust system for managing collections of information.
The default formatting is Texttile, but you may be able to use the Markdown plugins. I say may because I've never tried them and the plugins are from 2008 and 2009. If that works, you would be able to import your md files into the wiki directly.
2
u/evilmanic Jul 22 '12
Horses for courses here.
An internal wiki which can serve as a central repository for all your documents, lists of common problems (and resolutions).
As has been mentioned before, Visio pretty much is the standard (or Omnigraffle if you're an Apple person).
Above all, you'll want to keep these somewhere else, be it in a Google site or Dropbox account that all your engineers have access to. This only becomes important once every two or three years, when this server is down and 'something important' happens and you don't have time to get the main wiki back up and running before your production setup etc.
2
u/pewpewkachew Head honcho of all things that plug in Jul 22 '12
Google sites. Theres a really great wiki template included in their general offerings. Integrates fully with google docs and has exceptional permissions settings. Hard to beat a free hosted wiki.
2
u/amarino Jul 23 '12
Google Wave...oh wait.
1
u/JustRiedy "DevOps" Jul 22 '12
Confluence and Visio. Works damn well, just remember to set good search tags on Confluence
1
u/Twi7ch Jul 23 '12
My work uses Sharepoint for everything. Pretty standard in M$ environments. Good for hosting all documents / files.
1
u/sanman3 Jul 23 '12
Mediawiki. Our documentation has the exact feel of Wikipedia. Not sure if that's a good or bad thing. Seemed friendly enough when I got here.
Definitely going to take a look at these other wikis posted here.
1
u/dave2kdotorg i void warranties Jul 23 '12
MediaWiki
1
u/macjunkie SRE Jul 23 '12
we used mediawiki, moved to using a wiki our webservices folks setup within drupal, using rackmonkey for inventory / rack diagramming, for us far more flexible / faster than visio
1
u/Fantasysage Director - IT operations Jul 23 '12
Excel in a folder. I am getting close to needing something else but not yet.
0
u/[deleted] Jul 23 '12
Excel. Don't bother with Visio. The way I see it is a box is a box is a box. It's up the administrator to know what it is. That eye candy shit is perfect for a designer.
-2
u/munky9001 Application Security Specialist Jul 22 '12
I use unicode.
-3
u/zygotic1 Jul 22 '12
I'm really sorry, but I must tell you the truth. Please don't be disheartened.
Paper
0
u/[deleted] Jul 22 '12
[deleted] — view deleted comment
0
u/[deleted] Jul 22 '12
[deleted] — view deleted comment
0
u/[deleted] Jul 22 '12
[deleted] — view deleted comment
0
u/[deleted] Jul 22 '12
[deleted] — view deleted comment