Take the 2-minute tour ×
Server Fault is a question and answer site for professional system and network administrators. It's 100% free, no registration required.

I hope I'm not bothering anybody with this question. I have my technical documentation scattered using different methods, here is a list of the most used:

  • notebook I have several notebooks full of notes, I guess everybody has at least one.
  • git I have a repository called notes . It's quite simple, just using text notes, nothing fancy.
  • odt In the previous company I worked for, we used to write technical documentation using Open Office
  • wiki After trying the above methods I found this was the most useful, just because I only need a web browser to start writing things down.

Recently I start studying on my own an IT certification and I have all my notes in a notebook. I do not know which is the best way to keep my documentation available and updated.

What would you recommend me?

share|improve this question

closed as off topic by joeqwerty, Ward, Iain, Shane Madden, Tom O'Connor Oct 16 '11 at 20:06

Questions on Server Fault are expected to relate to professional server, networking, or related infrastructure administration within the scope defined by the community. Consider editing the question or leaving comments for improvement if you believe the question can be reworded to fit within the scope. Read more about reopening questions here.If this question can be reworded to fit the rules in the help center, please edit the question.

1  
This isn't a question specific to IT and could be applied to any field of work or study. There is no best way. There's my way and there's your way, but the best way for me may not be the best way for you. You might consider rephrasing the question like "How do you organize your documentation and why?". –  joeqwerty Oct 16 '11 at 17:05
    
You are totally right. I just want to know the different options or if I'm doing something wrong. –  Sergio Galvan Oct 16 '11 at 19:23

4 Answers 4

joeqwerty's comment is correct, this is totally subjective. That said, if you look at some of the older questions and answers for the documentation tag, there's a lot of good suggestions.

To answer in a more general sense, I think the main requirements for a good documentation system are:

  • Easy to start up or access, it has to be really fast to go into it to add or update some notes
  • Accessible to all team members
  • Accessible from wherever you are, your usual location, other people's computers, off-site, etc.

"The best" is whatever combination of shared files, sharepoint, wiki, docs stored/replicated in the cloud, etc., etc., works best for you.

share|improve this answer

I'm using Google Docs and i'm happy with that...

share|improve this answer

At my workplace, we have a CIFS share full of tons of documentation (most of it PDFs from manufacturers, etc.) that we use. What makes this convenient is any type of data can be stored and you need only remote to your work computer to access it.

That said, for purely text-based documentation, I've found the wiki i set up (using Mediawiki) to be very convenient. It puts all your documentation in a version-controlled database so you can see what changes were made, when they were made, and by whom. It also makes it very easy to find what you're looking for and move between different documents. Unfortunately, most of my coworkers are reluctant to use the system because they can't be bothered to learn the Mediawiki syntax, as easy as it is. If nothing else, it makes things easier for myself when I go back to work on something I set up months ago.

share|improve this answer

I use a Sharepoint document library. It allows me to create and upload Word, Excel, PDF documents, etc. That way I don't have to convert or save my documentation in a particular file format (other than it being a file type supported by Sharepoint document libraries).

share|improve this answer

Not the answer you're looking for? Browse other questions tagged or ask your own question.