| Line 6: | Line 6: | ||
Secondly, documentation is rarely done from the functional process perspective, such as "How to Set Up a New User". The traditional documentation would have the ACP -> Users page with screen shot and some field verbiage, and then in completely separate unrelated sections the ACP -> Edit Groups and then ACP -> Forums -> user related screens. Get the idea? No process "flow". A true "How to Set Up a New User" should walk the reader through the entire process from start to end. | Secondly, documentation is rarely done from the functional process perspective, such as "How to Set Up a New User". The traditional documentation would have the ACP -> Users page with screen shot and some field verbiage, and then in completely separate unrelated sections the ACP -> Edit Groups and then ACP -> Forums -> user related screens. Get the idea? No process "flow". A true "How to Set Up a New User" should walk the reader through the entire process from start to end. | ||
| + | |||
| + | [[RavenNuke2:Administering the Advertising Module|Administering the Advertising Module]] | ||
Revision as of 14:39, 18 September 2009
Home>Administration and Maintenance
To the eventual authors
What I have found to be so frustrating with technical / system documentation is the apparent tendency to put in a screen shot and just explain what each field is. So much of this type of documentation doesn't even go into what the valid values are in some of these fields AND, most importantly, what functionality is DRIVEN by the selection of these values.
Secondly, documentation is rarely done from the functional process perspective, such as "How to Set Up a New User". The traditional documentation would have the ACP -> Users page with screen shot and some field verbiage, and then in completely separate unrelated sections the ACP -> Edit Groups and then ACP -> Forums -> user related screens. Get the idea? No process "flow". A true "How to Set Up a New User" should walk the reader through the entire process from start to end.