req: Add logging and quality requirements

2 files changed, 65 insertions, 2 deletions

diff --git a/devel/requirements/5_nonfunctional.xml b/devel/requirements/5_nonfunctional.xml
index e8b2c82..22ab53b 100644
--- a/devel/requirements/5_nonfunctional.xml
+++ b/devel/requirements/5_nonfunctional.xml
@@ -28,5 +28,41 @@
             <title>SQA.Flexibility.FirmwareConf</title>
             <para>The firmware support described under the UI.Firmware.* requirements branch shall be disableable at run-time via a configuration setting.</para>
         </formalpara>
+        <formalpara id="SQA.Robustness.ScriptSync">
+            <title>SQA.Robustness.ScriptSync</title>
+            <para>The system shall provide a method to save the executed HorizonScript and log messages in the event of a fatal error.</para>
+        </formalpara>
+        <formalpara id="SQA.Usability.TTI.Experienced">
+            <title>SQA.Usability.TTI.Experienced</title>
+            <para>A User with experience installing other Linux distributions shall be able to complete the Horizon UI flow through <xref linkend="ui_perform" /> in less than 15 minutes.</para>
+        </formalpara>
+        <formalpara id="SQA.Usability.TTI.Green">
+            <title>SQA.Usability.TTI.Green</title>
+            <para>A User with no prior experience with Linux shall be able to complete the Horizon UI flow through <xref linkend="ui_perform" /> in less than one hour.</para>
+        </formalpara>
+        <formalpara id="SQA.Portability.Bitness">
+            <title>SQA.Portability.Bitness</title>
+            <para>A HorizonScript shall be readable on 32-bit and 64-bit computers regardless of what type of computer was used to create it.</para>
+        </formalpara>
+        <formalpara id="SQA.Portability.Endianness">
+            <title>SQA.Portability.Endianness</title>
+            <para>A HorizonScript shall be readable on big endian and little endian computers regardless of what type of computer was used to create it.</para>
+        </formalpara>
+        <formalpara id="SQA.Verifiability.BlockMock">
+            <title>SQA.Verifiability.BlockMock</title>
+            <para>The system shall support the ability to use "mock" block devices for purposes of testing and verification.</para>
+        </formalpara>
+        <formalpara id="SQA.Maintainability.Comments">
+            <title>SQA.Maintainability.Comments</title>
+            <para>All functions and methods in the system shall have a comment describing what action the function or method performs, and its inputs, outputs, and any side effects (if applicable).</para>
+        </formalpara>
+        <formalpara id="SQA.Maintainability.Methods">
+            <title>SQA.Maintainability.Methods</title>
+            <para>Each class in the system shall have no more than 20 methods.</para>
+        </formalpara>
+        <formalpara id="SQA.Maintainability.NoOPFuncs">
+            <title>SQA.Maintainability.NoOPFuncs</title>
+            <para>Each function or method in the system shall take no more than six input parameters.</para>
+        </formalpara>
     </section>
 </chapter>
diff --git a/devel/requirements/6_other.xml b/devel/requirements/6_other.xml
index c5aba8b..227a8bb 100644
--- a/devel/requirements/6_other.xml
+++ b/devel/requirements/6_other.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter label="6" id="other">
     <title>Other Requirements</title>
-    <para/>
+    <para>This chapter describes requirements that apply to the system but do not fit cleanly in other chapters.</para>
     <section id="documentation">
         <title>User Documentation</title>
         <formalpara id="UserDoc.JargonFree">
@@ -15,7 +15,34 @@
     </section>
     <section id="logging">
         <title>Logging Requirements</title>
-        <para/>
+        <formalpara id="Logging.Levels">
+            <title>Logging.Levels</title>
+            <para>The system shall have four levels of logging: Error, Warning, Information, Debug.</para>
+        </formalpara>
+        <formalpara id="Logging.Levels.Tiers">
+            <title>Logging.Levels.Tiers</title>
+            <para>The system shall treat each level of logging as containing the prior level: for example, a level of Warning will additionally contain all Error output.</para>
+        </formalpara>
+        <formalpara id="Logging.Levels.Default">
+            <title>Logging.Levels.Default</title>
+            <para>The system shall default to a logging level of Information unless a different logging level is chosen during invocation.</para>
+        </formalpara>
+        <formalpara id="Logging.ExtProcess">
+            <title>Logging.ExtProcess</title>
+            <para>The system shall log all processes executed, including binary path, arguments, and environment, in the Debug logging level.</para>
+        </formalpara>
+        <formalpara id="Logging.ExtProcess.ReturnCode">
+            <title>Logging.ExtProcess.ReturnCode</title>
+            <para>The system shall log all external process return codes, including name of binary and brief description of purpose of execution, in the Information log level.</para>
+        </formalpara>
+        <formalpara id="Logging.ExtProcess.ReturnCode.Error">
+            <title>Logging.ExtProcess.ReturnCode.Error</title>
+            <para>If the return code of an external process is non-zero, the system shall log the external process return code message in the Error log level.</para>
+        </formalpara>
+        <formalpara id="Logging.UIKeys">
+            <title>Logging.UIKeys</title>
+            <para>The Horizon UI system shall log the values it uses for each key as it gathers information in the Debug logging level.</para>
+        </formalpara>
     </section>
     <section id="i18n">
         <title>Internationalisation Requirements</title>