inghamn
commented
12 years ago All documentation, no matter who it's for needs to be available without needing to install the application, configure apache, or use PHP. These need to be plain files that do not rely on a webserver. This provides the documentation in the most usable format for folks who download application and need to know what to do with it.
This includes general user documentation as well. Having the user documentation as plain HTML files still allows it to be linked into from withing the application when it's installed on a webserver.
Having the HTML files use the same markup as the default templating for the application is fine - recommended, even. That way, the CSS links in the plain HTML files can point to the CSS in the /html/skins directory.
I keep going back and forth on this. The help documentation that is geared toward the general user should be a part of the templating system.
As opposed to anything geared toward system admins who might be working on the site while something isn't set up.
I can understand the site administrator using the GUI MAYBE not being part of the templating system, but it makes just as much sense to me with it being part of it, sense we set up a GUI so that they could use it.
Can you please comment so that I can figure out where to go from here? The help documentation that I'm writing will be available for our users as well, and having it within the navigation system would help tremendously. That would mean including the menunav and banner at least. If we go this route, would you want to set this stuff up and have me just create include files?