quote:I know the feeling, but I'm more of a soda person myself
Maybe I'm showing my lack of morning coffee yet,
quote:Exactly, I want to be able to go to the documentation with a question like "how do I allow ICQ or AIM to my users?" and be able to find that type of thing under a "Setting Member Priviledges" type of page. Or how to add a forum where the instructions would contain "Make sure you've added a category first. Click on the Add new Forum button next to the category." and such.
but I'm not sure what you mean by "Functionality based". :
Aha, I think I see what you mean now. You're talking about more of a walk-through type system. The problem with that is that there may come a time when the documentation would need to be re-worked completely, as the process could change completely.
quote:I would think the documentation should contain this so there is a "one-stop" shopping style where they don't have to go to multiple locations for answers.
My thoughts around that are that people who want the really nitty-gritty type thing can go and see what every single input box means.
quote:I would want to see a template for what information should be contained, whether to use screenshots, etc. If you're planning on doing most of the format to make it consistent, that's cool (I did see your other post), but I think making sure everyone is returning the same basic style of information will solve problems down the road.
Basic format: This one I honestly don't comprehend. What do you mean?
quote:
(All of this said in a friendly manner. It's early, so my apologies if I sound snippish. I tend to "think out loud" on BBSes a lot...)
quote:
Also, I think you ca write it in whatever you want, but if you keep it in a format like WORD, which most people have and can use, you have a better chance of getting it off the ground. Word's TOC and formatting features will allow for things to get done quickly once the text has been created. It can then be ported to whatever format/platform you desire. Besides... some people actually LIKE reading printed pages![]()
quote:
Dont even consider doing it in word. You must use some format that can be easily crossreferenced and can display on neraly every system with software that is both free and well distributed. HTML is the solution of chioce.
quote:
I am familor with XML . . but I cant for the life of me figgure out what that Docbook software does. Or is it even software?
quote:
I can help as well. But reading that infoIt takes in XML and outputs htm doc pdf and other formats right?