views:

60

answers:

2

When I try to document my server configuration steps in my blog it doesn't look structured. I need some kind of standards layout guide,something oriented towards howtos, with headers, steps, some kind of documentation creation standards that is supported by a wiki and can enforce or guide the document layout.

Is there any such documentation standards with an accompanying wiki toolset?

+2  A: 

give a try to DocBook

dfa
I think it will take some learning, but it shows the kind of structure I want. I think using its principles will turn out well in the long term
vfclists
A: 

I read standards conforming as simply "organized", or, "obvious to the reader". Consider the typical ways user documentation is typically organized. You are generally going to open up documentation in 3 different major use cases:

  1. The system is new, and you're trying to figure out what's going on. (PDFs, longer articles)
  2. You are looking up the details of something that you've forgotten. (Indexes to man-style reference information)
  3. You need help with a specific problem, and you're not exactly sure how this tool helps you. (Recipes, FAQs)

I'd probably try to copy one particular ecosystem (Windows, Unix, Apple), based around what the users are most familiar with.

Tristan Juricek