Merge pull request #28 from iana-internal/doc-update

Fixed the documentation description and the assurance cases numbering…

docs/README.md

@@ -1,14 +1,14 @@
 # DNSSEC KSK Management Tools - Documentation
 
-There are three documents contained in this sub-directory:
+The following documents are contained in this sub-directory:
 
-[User Documentation](usage.md) describes how to execute each command (i.e. KSR Signer; KSR Received; Keymaster; Trust Anchor Exporter; SHA-256 PGP Word calculator) on the command line.
+[User Documentation:](usage.md) Describes how to execute each command (i.e. KSR Signer; KSR Received; Keymaster; Trust Anchor Exporter; SHA-256 PGP Word calculator) on the command line.
 
-[Test Documentation](aep-keyper-test.md) describes how to test the KSR Signer using the AEP Keyper HSM.
+[Test Documentation:](aep-keyper-test.md) Describes how to test the KSR Signer using the AEP Keyper HSM.
 
-[Assurance cases](assurance-cases.md) documents the security claims about the system software and shows they are valid using a Claims-Arguments-Evidence notation.
+[Assurance Cases:](assurance-cases.md) Documents the security claims about the system software and shows they are valid using a Claims-Arguments-Evidence notation.
 
-[Architectural Design and Functional Specification](design-specifications.md)
-describes the high-level architectural design of the KSR Signer software, describing the security domains and functions maintained by the software.
+[Architectural Design and Functional Specification:](design-specifications.md)
+Describes the high-level architectural design of the KSR Signer software, describing the security domains and functions maintained by the software.
 
-[Test Framework](test.md) describes how to perform unit tests, what is cover and what is not covered.
+[Test Framework:](test.md) Describes the scope and method for unit testing.

docs/assurance-cases.md

@@ -34,11 +34,11 @@ The signer system will only **[proceed to process]** the KSR if a valid policy c
 
 Context: All parameters required to constitute a valid policy have been identified using the requirements from the DPS (Appendix A).
 
-### Sub Claim (1.1.2)
+### Sub Claim (1.1.1)
 
 The signer software checks that all **[required parameters]** exists and have been set to reasonable values in the **[configured policy]**.
 
-#### Argument (1.1.2.1)
+#### Argument (1.1.1.1)
 
 The **[configured policy]** is provided in the '--config' argument to 'keymaster.py' and defaults to 'ksrsigner.yaml' in the current directory.
 
@@ -47,15 +47,15 @@ The **[configured policy]** is provided in the '--config' argument to 'keymaster
 This is evident in 'main' from 'tools/ksrsigner.py'.
 
 
-#### Argument (1.1.2.2)
+#### Argument (1.1.1.2)
 
 The **[configured policy]** is parsed (in 'from\_yaml' of 'common/config.py') and checked to comply with the schema ('common/config\_schema.py').
 
 ##### Evidence
 
 Test cases provides evidence that (a) an invalid policy is rejected, and (b) a valid policy is accepted.
 
-#### Argument (1.1.2.3)
+#### Argument (1.1.1.3)
 
 If the **[configured policy]** does not comply with the schema, execution is aborted (in 'main' of 'tools/keymaster.py'). The program will not **[proceed to process]** the KSR.