Index: openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml,v
diff -u -r1.11.2.6 -r1.11.2.7
--- openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml 20 Nov 2004 05:08:56 -0000 1.11.2.6
+++ openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml 20 Nov 2004 20:07:20 -0000 1.11.2.7
@@ -133,7 +133,7 @@
OpenACS forums to 4th July 2003.
- OpenACS documentation should meet the following goals. No
+ OpenACS documentation should meet the following requirements. No
significance has been given to the order presented, topic breadth or depth here.
@@ -275,7 +275,7 @@
OpenACS forums to 4th July 2003.
- OpenACS end-user documentation should meet the following goals. No
+ OpenACS end-user documentation should meet the following requirements. No
significance has been given to the order presented, topic breadth or depth here.
@@ -406,7 +406,7 @@
OpenACS forums to 4th July 2003.
- OpenACS administrators' documentation should meet the following goals. No
+ OpenACS administrators' documentation should meet the following requirements. No
significance has been given to the order presented, topic breadth or depth here.
@@ -487,6 +487,48 @@
+
+ OpenACS Installation Documentation Requirements
+
+ By the OpenACS Community. This section is a collection of
+ documentation requirements that have been expressed in the
+ OpenACS forums to 4th July 2003.
+
+
+ OpenACS installation documentation should meet the following requirements. No
+ significance has been given to the order presented, topic breadth or depth here.
+
+
+
+ state installation prerequisites. For example: "You should
+ read through the installation process to familiarize
+ yourself with the installation process, before beginning an
+ installation."
+
+
+ list critical decisions (perhaps as questions) that need to
+ be made before starting: which OS, which DB, which aolserver
+ version, system name, dependencies et cetera. Maybe summarize
+ options as tables or decision-trees. For example, "As you
+ proceed throughout the installation, you will be acting on
+ decisions that have an impact on how the remaining part of
+ the system is installed. Here is a list of questions you
+ should answer before beginning."
+
+
+ list pre-installation assumptions
+
+
+ Show chronological overview of the process of installing a
+ system to full working status: Install operating
+ system with supporting software, configure with preparations
+ for OpenACS, RDBMS(s) install and configure, Webserver
+ install and configure, OpenACS install and configure,
+ post-install work
+
+
+
+
OpenACS Documentation Strategy: Why DocBook?