From fc2dc60c4e29840fd18bf25db6fd06f26aaef37b Mon Sep 17 00:00:00 2001
From: "A. Wilcox" <AWilcox@Wilcox-Tech.com>
Date: Sat, 31 Aug 2019 04:17:42 -0500
Subject: req: Move User Documentation to 6. Other; add some 2. content

---
 devel/requirements/2_description.xml | 17 +++++------------
 devel/requirements/6_other.xml       | 11 +++++++++++
 2 files changed, 16 insertions(+), 12 deletions(-)

(limited to 'devel/requirements')

diff --git a/devel/requirements/2_description.xml b/devel/requirements/2_description.xml
index b17cbe2..9e38ed7 100644
--- a/devel/requirements/2_description.xml
+++ b/devel/requirements/2_description.xml
@@ -1,31 +1,24 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter label="2" id="description">
     <title>Overall Description</title>
-    <para/>
+    <para>This chapter provides a high-level description of Project Horizon.  For more information on the background of Project Horizon, see <xref linkend="REF-1"/>.</para>
     <section id="perspective">
         <title>Project Perspective</title>
-        <para/>
-    </section>
-    <section id="features">
-        <title>Project Features</title>
-        <para/>
+        <para>Project Horizon is a new system that provides computer users and administrators the ability to install the Adélie Linux operating system.  It is intended to replace the current manual installation procedure for the use cases identified in <citetitle pubwork="chapter"><xref linkend="REF-1"/> sections 1.2.2 and 1.4</citetitle>.</para>
+        <para>It is expected over the next few years that Project Horizon will evolve with the Adélie family of software and services to provide a well-accepted libre environment for general purpose computing.</para>
     </section>
     <section id="users">
         <title>User Classes and Characteristics</title>
-        <para/>
+        <para>The identified user classes are defined in <citetitle pubwork="section"><xref linkend="REF-1"/> section 1.4</citetitle>.  A summary of these classes is included below.</para>
     </section>
     <section id="environment">
-        <title>Operating Enviornment</title>
+        <title>Operating Environment</title>
         <para/>
     </section>
     <section id="constraints">
         <title>Implementation Constraints</title>
         <para/>
     </section>
-    <section id="documentation">
-        <title>User Documentation</title>
-        <para/>
-    </section>
     <section id="assumptions">
         <title>Assumptions</title>
         <para/>
diff --git a/devel/requirements/6_other.xml b/devel/requirements/6_other.xml
index c24ed51..d8dc3f9 100644
--- a/devel/requirements/6_other.xml
+++ b/devel/requirements/6_other.xml
@@ -2,6 +2,17 @@
 <chapter label="6" id="other">
     <title>Other Requirements</title>
     <para/>
+    <section id="documentation">
+        <title>User Documentation</title>
+        <formalpara>
+            <title>UserDoc.JargonFree</title>
+            <para>The system documentation must contain minimal uses of technical jargon.  The system documentation must define technical jargon where it is first used.  "Jargon" is defined as a word that is technical in nature and is not listed in a Webster's or Oxford English dictionary.</para>
+        </formalpara>
+        <formalpara>
+            <title>UserDoc.ContextAware</title>
+            <para>The system must allow the user to read documentation relevant to the phase of installation that is currently on-screen.</para>
+        </formalpara>
+    </section>
     <section id="logging">
         <title>Logging Requirements</title>
         <para/>
-- 
cgit v1.2.3-60-g2f50