Fix markdown lint errors

This commit is contained in:
William Sandner
2023-03-24 17:29:16 +01:00
parent 0d20f4e5b1
commit c504fc26da
50 changed files with 702 additions and 637 deletions

View File

@@ -1,4 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
<!-- markdownlint-disable-next-line first-line-h1 -->
##### Project
::[PROJECT-NAME](Home)
@@ -17,20 +18,20 @@
**Process impact:** The statement of user needs documents and explains
the actual desires of stakeholders in roughly their own words. What they
*desire* is never exactly what the product *provides*. Documenting user
_desire_ is never exactly what the product _provides_. Documenting user
needs here, independently from the [SRS](SRS), helps to keep the
SRS precise and makes the tasks of verification and validation more
effective. This document is *not* an informal draft of the SRS, it is
effective. This document is _not_ an informal draft of the SRS, it is
different document with a complementary purpose.
### Agreed Goals
*TODO: Has there been a clear statement of the overall goal of this
_TODO: Has there been a clear statement of the overall goal of this
project that the stakeholders agree to? If so, paste it here or add a
hyperlink. If not, you should summarize your understanding of the
project goals into a brief statement and try to get the stakeholders to
agree to it. The text below gives three alternative examples, select
one, or write your own.*
one, or write your own._
::We were given an [initial project description](LINK) that is agreed to
by all stakeholders.
@@ -44,10 +45,10 @@ will be hyper-linked from here.
### Environment
*TODO: Briefly describe various aspects of the environment where the
_TODO: Briefly describe various aspects of the environment where the
software will be used. Describe the environment as it \*is\* or \*will be\*,
not what you would wish it to become. The text below gives a few
examples.*
examples._
#### What is the system's business environment?
@@ -70,10 +71,10 @@ co-located data center with 24x7 monitoring, UPS,
air-conditioning, etc. Users of this system are typically at
their offices.
:: This application runs on hand-held devices that will often be used
while the user is walking from one section of the warehouse
to another. Lighting is good in that environment, but there are many
noises and distractions.
:: This application runs on hand-held devices that will often be used
while the user is walking from one section of the warehouse
to another. Lighting is good in that environment, but there are many
noises and distractions.
#### What is the system's technology environment (hardware and software)?
@@ -87,25 +88,25 @@ monitors or laptops with 1024x768 resolution are also common.
### Stakeholders / Actors
*TODO: List and describe the stakeholders for this product. These can be
_TODO: List and describe the stakeholders for this product. These can be
named individuals or roles that people play. For each stakeholder,
list/rank their key needs. Consider the expected technical expertise of
the stakeholders and how often they are likely to use the system, as
well as key strengths, weaknesses, preferences, or other
characteristics. Use a greater-than sign to indicate inheritance among
types of actors.*
types of actors._
*TIP: To get information on types of users, you can talk to actual users.
_TIP: To get information on types of users, you can talk to actual users.
You may also want to talk to user surrogates (people who work with
users), such as domain experts, technical trainers, technical support
staff, technical writers, supervisors of users, and your own sales and
marketing department. You can find clues in manuals and marketing
materials for competing products.*
materials for competing products._
#### ::All
:: All stakeholders share the following key needs:
:: All stakeholders share the following key needs:
1. ::Security against abuses by other site visitors
2. ::Convenient access to the site any time over the Internet
@@ -120,7 +121,7 @@ users and have high expectations for the functionality and quality
of the site, but they may not have much knowledge of
computer science.
:: Key needs:
:: Key needs:
1. ::Easily find information about clans
2. ::Keep in touch with members of his/her own clan
@@ -148,16 +149,16 @@ more of the game details, now the need to see the "big picture".
::PARAGRAPH
#### ::STAKEHOLDER3
::PARAGRAPH
### Notes from Interviews and Brainstorming
*TODO: Keep a log of your requirements gathering. Paste in notes from any
_TODO: Keep a log of your requirements gathering. Paste in notes from any
face-to-face or telephone conversations with stakeholders or from
brainstorming sessions with members of the development team. If the
communication took place via email, link to it in the archive or paste
it here.*
it here._
#### ::DATE, INTERVIEWEE
@@ -181,13 +182,13 @@ it here.*
### User Stories
*TODO: Write brief user stories to explain how various actors would
_TODO: Write brief user stories to explain how various actors would
interact with the system (directly and indirectly) to accomplish a
real-world goal. User stories are \*not\* use cases: user stories are
brief (3-5 sentences) paragraphs that describe one specific scenario in
concrete terms. In this description of user needs, do not make
assumptions about details of the system, instead focus on the users.
Note the source of each user story.*
Note the source of each user story._
#### ::invited-to-join
@@ -219,9 +220,9 @@ clan website to find that information. (Source: PERSON-NAME)
### Performance and Capacity Needs
*TODO: Briefly list the stakeholders' desired values for various aspects
_TODO: Briefly list the stakeholders' desired values for various aspects
of the system capacity. If you have a good idea about averages or rates
of increase, note that as well.*
of increase, note that as well._
::By the end of the first year of service, we should to reach the
following system capacity: