From 70a43d171f0505853558f51988b9a85c68fafdda Mon Sep 17 00:00:00 2001 From: William Sandner Date: Sun, 1 Aug 2021 14:47:55 +0200 Subject: [PATCH] Fix linter warnings --- Feature-Set.md | 3 ++- Features.md | 1 + Glossary-Standard-Terms.md | 1 + Glossary.md | 1 + Home.md | 2 ++ Implementation-Notes.md | 19 ++++++++++++------- 6 files changed, 19 insertions(+), 8 deletions(-) diff --git a/Feature-Set.md b/Feature-Set.md index a64f438..1325cd9 100644 --- a/Feature-Set.md +++ b/Feature-Set.md @@ -1,3 +1,4 @@ + ##### Project ::PROJECT-NAME @@ -70,7 +71,7 @@ consider estimated effort and risk.* ### Features by Release and Risk - ::Release 1.0 - - ::[F-00](Features#f-00_site_configurtion) Safe : Site configuration + - ::[F-00](Features#f-00_site_configuration) Safe : Site configuration - ::[F-01](Features#f-01_user_registration) Safe : User registration - ::[F-21](Features#f-21_feature_name) Safe : NAME OF FEATURE - ::[F-31](Features#f-31_feature_name) 1-Risk : NAME OF FEATURE diff --git a/Features.md b/Features.md index 5831a4e..a3c3f11 100644 --- a/Features.md +++ b/Features.md @@ -1,3 +1,4 @@ + ##### Project ::PROJECT-NAME diff --git a/Glossary-Standard-Terms.md b/Glossary-Standard-Terms.md index b43a16d..6e43e9b 100644 --- a/Glossary-Standard-Terms.md +++ b/Glossary-Standard-Terms.md @@ -1,3 +1,4 @@ + **Process impact:** This file as a dictionary of standard terms defined as they are used across projects. Individual projects should not need to edit this file. Writing out the definitions of terms and acronyms here diff --git a/Glossary.md b/Glossary.md index f086480..e94b7ae 100644 --- a/Glossary.md +++ b/Glossary.md @@ -1,3 +1,4 @@ + **Process impact:** This file as a dictionary of terms defined as they are used during the project. Writing out the definitions of terms and acronyms here helps keep other documents more concise and precise. A diff --git a/Home.md b/Home.md index c7d0e70..6e87177 100644 --- a/Home.md +++ b/Home.md @@ -1,5 +1,7 @@ + ### Mission and Scope + *TODO: Answer these questions in your own words by filling in each* #### What problem does this project address? diff --git a/Implementation-Notes.md b/Implementation-Notes.md index ddbc778..eff4d80 100644 --- a/Implementation-Notes.md +++ b/Implementation-Notes.md @@ -1,14 +1,19 @@ + ##### Project + ::[PROJECT-NAME](Home) -##### Release(s): +##### Internal Release Number + ::X.Y.Z ##### Related Documents + - [Software Requirements Specification](SRS) - [Release notes](Release-Notes) - [FAQ](FAQ) - [Glossary](Glossary) + --- **Process impact:** This document is a brief and fairly technical @@ -198,11 +203,11 @@ Do these implementation notes provide enough information for operations engineer - ::Yes, these notes have been reviewed by the operations team and requested changes have been incorporated. -- ::No, these notes only summarize parts of a larger - [operations manual](LINK-TO-OPERTIONS-MANUAL). +- ::No, these notes only summarize parts of a larger + [operations manual](LINK-TO-OPERATIONS-MANUAL). - ::No, a member of the development team is available on-call whenever - the operations team may need help. This is listed in the - [Resource Needs](Resource-Needs) document and in the + the operations team may need help. This is listed in the + [Resource Needs](Resource-Needs) document and in the [on-call schedule](LINK-TO-ON-CALL-SCHEDULE). Have these implementation notes been communicated to the operations and development teams and other stakeholders? @@ -210,6 +215,6 @@ Have these implementation notes been communicated to the operations and developm - ::Yes, everyone has had a chance to review them. Feedback is welcome. - ::Yes, it has been posted to the project website. - ::No, some developers or operations engineers are not aware of - this document. This is a risk that is noted in the - [Risk Management](Project-Plan#risk-management) section of the + this document. This is a risk that is noted in the + [Risk Management](Project-Plan#risk-management) section of the [Project Plan](Project-Plan).