Forum OpenACS Development: place for user documentation

Collapse
1: place for user documentation
Posted by Rafael Calvo on 10/26/01 01:37 AM
Hi

calendar and wp-slim have some new user documenation. I wonder if we
can standarize the place to put it. Mi idea is in $package/www/help
and in a index.adp file that uses the templating system. This way when
you install a package *users* will have some help in the same format
as the rest of the site.
/doc is not good for users, it is confusing to start looking on how to
"add an appointment" on explanation of the data model...

What do people think?

Collapse
2: Response to place for user documentation (response to 1)
Posted by Neophytos Demetriou on 10/26/01 01:47 AM
I will second that -- www/help for user documentation.
Collapse
3: Response to place for user documentation (response to 1)
Posted by Roger Williams on 10/26/01 05:54 PM
Why would it not but put in www/doc? That directory already exists and it pointed to when doc is accessed, althoughit is only programming docs (e.g. Requirements, Design), so far.

Regards..

Collapse
4: Response to place for user documentation (response to 1)
Posted by David Walker on 10/26/01 06:04 PM
I definitely want to keep user docs and programer docs separate.
/help seems good to me
Collapse
5: Response to place for user documentation (response to 1)
Posted by Rafael Calvo on 10/28/01 06:23 AM
Roger,

My point is that users should be *saved* from having to even look at developer documentation. If I am going to make a non profit site for women's breast cancer, I don't want these people to look at an ER diagram, I am sure they would leave and go to see the show 😊

For now, until we stablish some standard across OACS I will putting user FAQs in /help (for calendar and Wimpy point)

Collapse
6: Response to place for user documentation (response to 1)
Posted by Roger Williams on 10/28/01 06:35 PM
This sounds OK to me. On the project I am on, we are writing documentation for most of the modules we will use. And we intend to put links in the user screens to point to these pages. I will let you guys know what we do once we have some docs to show.

Regards..