diff options
| author | Joel Sherrill <joel@rtems.org> | 2018-11-28 18:18:38 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel@rtems.org> | 2018-12-09 17:06:04 -0600 |
| commit | f1a5c56f4b05a86cc3df30fa997adbf38363271c (patch) | |
| tree | 36e70b77aa8c383a08bcd401907c5d6896ae4cc6 | |
| parent | 0ca4b12e9d708684362a302a59d08c472925aeec (diff) | |
eng: Clean up.
| -rw-r--r-- | eng/appendix-a.rst | 5 | ||||
| -rw-r--r-- | eng/index.rst | 1 | ||||
| -rw-r--r-- | eng/management.rst | 2 | ||||
| -rw-r--r-- | eng/users-manuals.rst | 6 |
4 files changed, 10 insertions, 4 deletions
diff --git a/eng/appendix-a.rst b/eng/appendix-a.rst index dfc141f..633996b 100644 --- a/eng/appendix-a.rst +++ b/eng/appendix-a.rst @@ -27,8 +27,9 @@ that form a strong foundation for a software engineering qualification effort. TBD convert to a table; see original PDF for guidance on desired look +TBD The PDF is in https://ftp.rtems.org/pub/rtems/people/joel/sw_eng_hb/ -============================================= +.. COMMENT: ====================================== BEGIN Table 1. Core Qualification Artifacts Category Artifact Intent @@ -72,7 +73,7 @@ The project shall ensure that the software code is unit tested per the plans for Usability Software User’s Manual The Software User Manual defines user instructions for the software. -============================================= +.. COMMENT: ====================================== END In an effort to remain lightweight and sustainable for open-source projects, Table 1 above was condensed into a single artifact outline diff --git a/eng/index.rst b/eng/index.rst index 5fe93d4..9d48ac4 100644 --- a/eng/index.rst +++ b/eng/index.rst @@ -50,6 +50,7 @@ to the Community Project hosted at http://www.rtems.org/. prequalification stakeholders management + test-plan release-mgmt users-manuals license-requirements diff --git a/eng/management.rst b/eng/management.rst index 3ed36d4..6494819 100644 --- a/eng/management.rst +++ b/eng/management.rst @@ -17,7 +17,7 @@ TBD - and insert here .. toctree:: vc-users - vc-writers + vc-authors coding change-management issue-tracking diff --git a/eng/users-manuals.rst b/eng/users-manuals.rst index e6c5dfa..e3b102d 100644 --- a/eng/users-manuals.rst +++ b/eng/users-manuals.rst @@ -5,7 +5,7 @@ User's Manuals -********************************* +************** TBD - write and link to useful documentation, potential URLs: @@ -28,3 +28,7 @@ Reference any other existing user documentation * https://docs.rtems.org/releases/rtemsdocs-4.10.1/share/rtems/html/ +Documentation Style Guidelines +============================== + +TBD - write me |