From 242ffe9d55e72efd5bc1ea9bdc7b8fad4bd72f6e Mon Sep 17 00:00:00 2001 From: William Sandner Date: Sat, 25 Mar 2023 12:32:32 +0100 Subject: [PATCH] Fix linter issues --- Feature-Format.md | 1 - Glossary-Standard-Terms.md | 26 +++++++++++++------------- Use-Case-Format.md | 4 ++-- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/Feature-Format.md b/Feature-Format.md index 0bde532..99f7f2e 100644 --- a/Feature-Format.md +++ b/Feature-Format.md @@ -1,5 +1,4 @@ - ##### Project ::[PROJECT-NAME](Home) diff --git a/Glossary-Standard-Terms.md b/Glossary-Standard-Terms.md index 1a9a4a1..4248255 100644 --- a/Glossary-Standard-Terms.md +++ b/Glossary-Standard-Terms.md @@ -6,7 +6,7 @@ helps keep other documents more concise and easy to edit. Check the [ReadySET glossary](https://web.archive.org/web/20200702035436/http://readyset.tigris.org/templates/glossary-std.html) for updates. -Jump to: [General](#general-terms) | [Computer science & technology](#computer-science-and-technology-terms) | [Process](#process-terms) | [Software development tools](#development-tool-terms) | [Requirements](#requirements-terms) | [Design](#design-terms) | [Design goals terms](#desigD-DIAGRAMn-goals-terms) | [QA terms](#qa-terms) | [QA goals terms](#qa-goals-terms) | [Additional terms](#additional-standard-terms)| [Project terms](Glossary) +Jump to: [General](#general-terms) | [Computer science & technology](#computer-science-and-technology-terms) | [Process](#process-terms) | [Software development tools](#development-tool-terms) | [Requirements](#requirements-terms) | [Design](#design-terms) | [Design goals terms](#design-goals-terms) | [QA terms](#qa-terms) | [QA goals terms](#qa-goals-terms) | [Additional terms](#additional-standard-terms)| [Project terms](Glossary) ## General Terms @@ -137,8 +137,8 @@ than "10.1" or "11". ### Release Number -The term "release number" by itself refers to an -[external release number](#external_release_number). Users normally are not aware +The term "release number" by itself refers to an +[external release number](#external-release-number). Users normally are not aware of the existence of any internal release numbers. ## Development Tool Terms @@ -322,18 +322,18 @@ this system. ### Bug -_n._ **Deprecated** since 1991. See [defect](#defect). +*n.* **Deprecated** since 1991. See [defect](#defect). ### Error -_v._ A mistaken thought in the developer's mind. Often caused by +*v.* A mistaken thought in the developer's mind. Often caused by miscommunication or bad assumptions. Errors can create [defects](#defect). E.g., a developer might erroneously think that the square root of -4 is -2. ### Defect -_n._ The result of the developer's [error](#error) embodied in the +*n.* The result of the developer's [error](#error) embodied in the product source code, initial data, or documents. E.g., a square root function which allows negative numbers as arguments is defective. Defects can be removed by changing the source code, initial data, @@ -341,7 +341,7 @@ or document. ### Fault -_n._ The execution of defective code. E.g., if a certain input is +*n.* The execution of defective code. E.g., if a certain input is provided to defective code, it may cause an exception, or go into an infinite loop, or store an incorrect value in an internal variable. A fault is not normally visible to users, only the @@ -349,7 +349,7 @@ A fault is not normally visible to users, only the ### Failure -_n._ The user-visible result of a [fault](#fault). E.g., an error +*n.* The user-visible result of a [fault](#fault). E.g., an error message or an incorrect result. This is evidence that can be reported in a defect report. Developers use failure evidence during debugging to eventually find and remove [defects](#defect). @@ -386,10 +386,10 @@ this document. Is the data in the system a true representation of the real world? Any system that contains initial data or gathers data about the real -D-DIAGRAM -D-DIAGRAM -D-DIAGRAM -D-DIAGRAM +world should be sure that the data is factually correct. E.g., a tax +preparation program should embody correct and up-to-date facts about +tax law. + #### Usability > Understandability and Readability Users need to understand the system to use it. The basic metaphor @@ -534,6 +534,6 @@ For additional standard terms, see the following reference sites: - [Dictionary.com](http://www.dictionary.com/) - [Whatis.com](http://www.whatis.com/) - [NIST Dictionary of Algorithms and Data Structures](http://www.nist.gov/dads/) -- [Free on-line dictionary of computing](http:/http://foldoc.doc.ic.ac.uk/foldoc/index.html) +- [Free on-line dictionary of computing](http://foldoc.doc.ic.ac.uk/foldoc/index.html) - [IBM's glossary of computing terms](http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm) - [Jargon File](http://www.jargon.org/) diff --git a/Use-Case-Format.md b/Use-Case-Format.md index 59b7c84..11fedb4 100644 --- a/Use-Case-Format.md +++ b/Use-Case-Format.md @@ -31,9 +31,9 @@ file.* **Prerequisite:** ::Project is set up -_TODO: Copy and paste this use case template as many times as needed in +*TODO: Copy and paste this use case template as many times as needed in your [Use Cases](Use-Cases) document. Only use those fields that -are not the same as the default for all use cases._ +are not the same as the default for all use cases.* ---