More structure suggestions.
Posted: Thu Sep 15, 2005 9:07 pm
Since I've joined the documentation team, I thought I'd chip in with a few suggestions.
I always find the best documentation serves two purposes, first as a clearly structured reference, and second as a step by step guide to building a site that uses all the features as both an example and a tutorial.
For example you'd start by installing, then by making a template, then perhaps by adding a stylesheet, then you'd add content, edit content, etc
I like the structure proposals that have gone before this so what I guess i'm really saying is perhaps we should figure out an example site which will use every feature of the CMS and document the construction of this site step by step through the documentation. That way we have a double, or heck, even a treble edged sword.
Another thing we must be mindful of is the fact that tasks are often delegated to different users, and so we need to make the sections stand on their own as well, for example a server admin might install the CMS, then a designer might come and make a template, then a staff member might fill the content in, then a coder might add a fancy feature, etc
Just thought I'd chip in with my suggestions before the documentation project starts in earnest.
I always find the best documentation serves two purposes, first as a clearly structured reference, and second as a step by step guide to building a site that uses all the features as both an example and a tutorial.
For example you'd start by installing, then by making a template, then perhaps by adding a stylesheet, then you'd add content, edit content, etc
I like the structure proposals that have gone before this so what I guess i'm really saying is perhaps we should figure out an example site which will use every feature of the CMS and document the construction of this site step by step through the documentation. That way we have a double, or heck, even a treble edged sword.
Another thing we must be mindful of is the fact that tasks are often delegated to different users, and so we need to make the sections stand on their own as well, for example a server admin might install the CMS, then a designer might come and make a template, then a staff member might fill the content in, then a coder might add a fancy feature, etc
Just thought I'd chip in with my suggestions before the documentation project starts in earnest.