IT Documentation Helpers
-
So in working on developing some documentation for my current employer it's rather apparent that having to work in a Word document, although functional is a huge pain in the rear.
I'm looking for some decent tools to help with developing and maintaining our IT Documentation.
Thanks in advance.
-
@DustinB3403 I use a Drupal blog. Simple and easy to manage.
-
Do you have Office365 with Team Sites? I found that the hosted Sharepoint wiki is really good for this type of thing. Especially since it doesn't rely on anything local, except internet access.
-
If you don't have O365, you could use the existing website as a place to work from.
This is where having it hosted is 'good' as you get some tools which you can use. Build a subdomain and install a Wiki or as @travisdh1 mentioned Drupal and run from there.
-
MediaWiki, Sharepoint's Wiki, OneNote are all decent tools for this.
-
If you're looking for something small, portable, and secure, TiddlyWiki is a decent option. I use it for most of my documentation as it is standalone and doesn't require a separate server/service to be running to use it. If you're needing to supply multiple users with access and/or have multiple people editing documents, it probably isn't the best choice.
-
We use MediaWiki
-
For existing systems, check out SYDI
-
I'm using a SharePoint wiki, lots of Visio drawings and some UML/SysML diagrams. But using (on-premise) SharePoint isn't smart at all. Heavily depends on a lot of things, and you want your documentation to be accessible when things go south.
Another thing on my todo list: Migrate to some lightweight blog or wiki engine that doesn't need any database, webserver and serverside scripting language. Something you can run from your USB stick on any OS in any JS capable browser for example.
https://hexo.io/ looks pretty nice.
-
Interns work a treat
-
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
-
@Jstear said in IT Documentation Helpers:
For existing systems, check out SYDI
I think I've used SYDI before, sounds very familiar....
-
@DustinB3403 said in IT Documentation Helpers:
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
Agree. They need to learn, sure, but not on what's driving your business
-
@thwr said in IT Documentation Helpers:
@DustinB3403 said in IT Documentation Helpers:
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
Agree. They need to learn, sure, but not on what's driving your business
They can't legally learn on what's driving the business in the US.
-
@scottalanmiller said in IT Documentation Helpers:
@thwr said in IT Documentation Helpers:
@DustinB3403 said in IT Documentation Helpers:
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
Agree. They need to learn, sure, but not on what's driving your business
They can't legally learn on what's driving the business in the US.
You are mean
-
@DustinB3403 said in IT Documentation Helpers:
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
You need to work on your beatings, technique must be off
-
@MattSpeller said in IT Documentation Helpers:
@DustinB3403 said in IT Documentation Helpers:
@MattSpeller said in IT Documentation Helpers:
Interns work a treat
I'm plumb out, and I often hate the resulting work provided...
You need to work on your beatings, technique must be off
Mwaha... One of my colleagues just said this today: "You are an expert at punishing people"
-
So I have used SYDI before (after rerunning it it all came back as "OH YEAH!")
And this is a rather great tool for basic system documentation, but not really so great for Disaster recovery kinds of documentation. But I could certainly use this to generate documentation on the systems in the business as a starting point, or reference system.
-
@Jstear said in IT Documentation Helpers:
For existing systems, check out SYDI
Anyone got screenshots of SYDI? What does it actually look like?
-
@scottalanmiller said in IT Documentation Helpers:
@Jstear said in IT Documentation Helpers:
For existing systems, check out SYDI
Anyone got screenshots of SYDI? What does it actually look like?
I'll abstract some info from a system I'm scanning, give me 15.
