Git Product home page Git Product logo

seliproject's Issues

REQUEST FOR [0002]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQUEST FOR [0007]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQUEST FOR 0008

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQUEST FOR 0012

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Not so good idea

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Ask for some feature 0007

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

ISSUE_[CATEGORY_INDEX]_[INDEX] SUBJECT

Add to the title the category index.
Not obligatory, but add bug priority as a label.

title: REQ_[CATEGORY]_[INDEX] SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

[A] Should be a good idea

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Ask for some feature 0003

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Ask for some feature 0009

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

ISSUE_SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

Ask for a feature 0004

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQ_ SUBJECT

USER STORIES

This states all of the scenarios of the users involved.

REQUEST FOR [0001]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_ 0001

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

REQ_ SUBJECT

INDEX

1 REQUIREMENT

1.1 USER STORIES

1.2 WORKFLOW

1.3 REQUIREMENTS (DETAILS)

1.4 WIREFRAMES

2 RESOURCES

2.1 TOOLS

2.2 SUGGESTED IMPLEMENTATION

2.3 REFERENCES

3 GLOSSARY

REQUIREMENT

USER STORIES

This states all of the scenarios of the users involved.

[ ] i.e #12
[ ]

WORKFLOW

This should include a picture of the screens involved.
Error states and view changes based on role should be documented.
This picture is worth a thousand words, as the details of the flow through the feature can be quite complex, and this is hard to spell out the details in the next section. We have been using Gliffy, a confluence plugin, and it rocks. It is a flash app that allows us to create and edit the workflows with eases.

REQUIREMENT DETAILS

These are the details of the feature. Document all screen(s) and every field, label, validation, message, and action. This is essentially the functional specification of the details of the screen(s) involved. Because it is in the context of the wireframe (next section), it is more concise. You can simply reference the field name, rather than verbosely state everything about the field. You can keep the details to field length, required, etc.

WIREFRAMES

A picture is required for each screen involved. Wireframes can be simple drawings on a whiteboard that are photographed, or a set of boxes created in Visio or OmniGraffle (or anything really). Some are photoshop-ed, and others are HTML. We have found that the best approach is HTML if that’s your end result. Recreating HTML that looks the exact same as a picture can be quite painful. Usually, a visual designer is involved in creating the mock ups, and can easily do this work in HTML. The developers can therefore take the exact HTML that is requested, and fill in their code as needed.


RESOURCES

SUGGESTED IMPLEMENTATION

Some code or pseudo-code


SUGGESTED TOOLS

PLUGINS, LIBRARIES, FRAMEWORKS, ETC
1.
2.
3.

REFERENCES


GLOSSARY

Ask for some feature 0001

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_ SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

EPIC Web Redesign

Description

Initiative / goal

Hypothesis

Acceptance criteria and must have scope

Stakeholders

Timeline

BUG_ SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

Automated?

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Ask for some feature 0005

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Ask for some feature 0008

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_ 0004

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

BUG_ 0003

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

REQ_ SUBJECT

USER STORIES

This states all of the scenarios of the users involved.

REQUEST FOR [0006]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_ 0002

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

ISSUE_SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

Ask for some feature 0002

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQUEST FOR [0003]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

REQUEST FOR [0005]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQUEST FOR [0004]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQ_[CATEGORY]_[INDEX] SUBJECT

INDEX

1 REQUIREMENT
1.1 USER STORIES
1.2 USER ACCEPTANCE TESTS
1.3 WORKFLOW
1.4 REQUIREMENTS (DETAILS)
1.5 WIREFRAMES
1.6 REFERENCED REQUIREMENTS
2 RESOURCES
2.1 TOOLS
2.2 SUGGESTED IMPLEMENTATION
2.3 REFERENCES
3 GLOSSARY

REQUIREMENT

USER STORIES

This states all of the scenarios of the users involved. These should read:
As a SOME ROLE,
I want to DO SOMETHING,
So that I CAN GET SOME BENEFIT
The user stories are critical to lay out exactly who is going to do what, and for what reason(s).

USER ACCEPTANCE TESTS

These should include all scenarios outlined in the user stories. These should not be too detailed (they don’t need to mention specific screens or a complete list of actions to execute the steps). These should read:

GIVEN that condition 1 and condition 2….
WHEN I do step 1, and step 2…
THEN, desired result 1, desired result 2….

These define a set of actual scenarios a tester could walk through to assert that the feature is complete. These are not detailed test scripts that you find in UAT. They are meant to convey a set of tests that all involved can walk through to understand how the feature will work.

WORKFLOW

This should include a picture of the screens involved.
Error states and view changes based on role should be documented.
This picture is worth a thousand words, as the details of the flow through the feature can be quite complex, and this is hard to spell out the details in the next section. We have been using Gliffy, a confluence plugin, and it rocks. It is a flash app that allows us to create and edit the workflows with eases.

REQUIREMENT DETAILS

These are the details of the feature. Document all screen(s) and every field, label, validation, message, and action. This is essentially the functional specification of the details of the screen(s) involved. Because it is in the context of the wireframe (next section), it is more concise. You can simply reference the field name, rather than verbosely state everything about the field. You can keep the details to field length, required, etc.

WIREFRAMES

A picture is required for each screen involved. Wireframes can be simple drawings on a whiteboard that are photographed, or a set of boxes created in Visio or OmniGraffle (or anything really). Some are photoshop-ed, and others are HTML. We have found that the best approach is HTML if that’s your end result. Recreating HTML that looks the exact same as a picture can be quite painful. Usually, a visual designer is involved in creating the mock ups, and can easily do this work in HTML. The developers can therefore take the exact HTML that is requested, and fill in their code as needed.

REFERENCED REQUIREMENTS

RESOURCES

SUGGESTED IMPLEMENTATION

Some code or pseudo-code


TOOLS

PLUGINS, LIBRARIES, FRAMEWORKS, ETC
1.
2.
3.

REFERENCES

GLOSSARY

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

ISSUE_SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

BUG_[CATEGORY_INDEX]_[INDEX] SUBJECT

Add to the title the category index.
Not obligatory, but add bug priority as a label.

title: REQ_[CATEGORY]_[INDEX] SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

REQUEST FOR [0010]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_[CATEGORY_INDEX]_[INDEX] SUBJECT

Add to the title the category index.
Not obligatory, but add bug priority as a label.

title: REQ_[CATEGORY]_[INDEX] SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

REQUEST FOR [0011]

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

REQ_ SUBJECT

INDEX

1 REQUIREMENT

1.1 USER STORIES

1.2 WORKFLOW

1.3 REQUIREMENTS (DETAILS)

1.4 WIREFRAMES

2 RESOURCES

2.1 TOOLS

2.2 SUGGESTED IMPLEMENTATION

2.3 REFERENCES

3 GLOSSARY

REQUIREMENT

USER STORIES

This states all of the scenarios of the users involved.

[ ] i.e #12
[ ]

WORKFLOW

This should include a picture of the screens involved.
Error states and view changes based on role should be documented.
This picture is worth a thousand words, as the details of the flow through the feature can be quite complex, and this is hard to spell out the details in the next section. We have been using Gliffy, a confluence plugin, and it rocks. It is a flash app that allows us to create and edit the workflows with eases.

REQUIREMENT DETAILS

These are the details of the feature. Document all screen(s) and every field, label, validation, message, and action. This is essentially the functional specification of the details of the screen(s) involved. Because it is in the context of the wireframe (next section), it is more concise. You can simply reference the field name, rather than verbosely state everything about the field. You can keep the details to field length, required, etc.

WIREFRAMES

A picture is required for each screen involved. Wireframes can be simple drawings on a whiteboard that are photographed, or a set of boxes created in Visio or OmniGraffle (or anything really). Some are photoshop-ed, and others are HTML. We have found that the best approach is HTML if that’s your end result. Recreating HTML that looks the exact same as a picture can be quite painful. Usually, a visual designer is involved in creating the mock ups, and can easily do this work in HTML. The developers can therefore take the exact HTML that is requested, and fill in their code as needed.


RESOURCES

SUGGESTED IMPLEMENTATION

Some code or pseudo-code


SUGGESTED TOOLS

PLUGINS, LIBRARIES, FRAMEWORKS, ETC
1.
2.
3.

REFERENCES


GLOSSARY

Something like this

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

I'm not sure

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

BUG_SUBJECT

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Browser: all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView

Possible Solution

Possible Implementation

Related issues

Glossary

⚠️ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119/8174.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  2. MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  3. SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
  5. MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Bug Categories

INDEX NAME DESCRIPTION
a11y Accessibility fault Accessibility related problems
API API Bug API is broken or invalid response is coming.
APP Application Crash Mobile apps are the biggest source of this bug. Some of the functions that can lead to crash of the application. These needs to be identified as early as possible and needs to be rectified.
BROWSER Browser Compatibility Sometimes latest updates are available and the program may not be compatible with the same.
CALC Calculation bugs improper logic for calculation. The bright example of such an error is the lost Mars Climate Orbiter. Such situation happened because there were used English units in the metric system.
COMM Communication issues The process of user’s communication with the product may be impossible because of this type of errors, for example, the guide is unavailable or the notifications are not shown.
FLOW Control flow bugs the violation of the sequence of actions.
DB Database Bugs If Data in the data base is not getting refreshed \ updated \ deleted or edited
FUNCTIONAL Functional Bugs The improper system behavior or enabled product features.
GUI GUI Related Bugs Relates to design of the Interface. It is either related to the Application Form \ Reports of the application. Also Page Layout issue on Various Screen Sizes can be come under this definition
ERRORS Improper handling of the errors if something goes wrong, the user should get the proper and clear notification. Its text should be short and contain all necessary information about the nature of the error and the ways of its possible removal.
10n Localization localization related problems
CMD Missing commands some expected commands are omitted in the system.
SYNTACTIC Syntactic bugs the grammar mistakes or misspelled words and sentences used in product GUI.
SYS System Related bugs Any program which is not compatible with the Operating system, Hardware or the environment can lead to system related bugs
SSP Software Service Pack In case new updates are available in the system and application is not compatible with the new updates can lead to these bugs

The above-mentioned errors can be detected during different types of software testing, for example, functional, system, integration checking, etc. Besides that, there are several unusual bugs that may cause some difficulties in their discovering and fixing.

Bug Priorities

PRIORITY DESCPRITION
LOW Bugs that do not interfere with core functionality and are just annoyances that may or may not ever be fixed.
MEDIUM Bugs that do not affect any critical user functionality.
HIGH Bugs that are related to the core functionality of the application, but don’t have to be fixed before product launch. However, these bugs should be fixed in the first available patch or release after launch.
CRITICAL Bugs that are mission critical to the core functionality of the application and for which there are no workarounds. These bugs absolutely must be fixed before the customer can release the app to the public.

REQ_ SUBJECT

INDEX

1 REQUIREMENT

1.1 USER STORIES

1.2 WORKFLOW

1.3 REQUIREMENTS (DETAILS)

1.4 WIREFRAMES

2 RESOURCES

2.1 TOOLS

2.2 SUGGESTED IMPLEMENTATION

2.3 REFERENCES

3 GLOSSARY

REQUIREMENT

USER STORIES

This states all of the scenarios of the users involved.

[ ] i.e #12
[ ]

WORKFLOW

This should include a picture of the screens involved.
Error states and view changes based on role should be documented.
This picture is worth a thousand words, as the details of the flow through the feature can be quite complex, and this is hard to spell out the details in the next section. We have been using Gliffy, a confluence plugin, and it rocks. It is a flash app that allows us to create and edit the workflows with eases.

REQUIREMENT DETAILS

These are the details of the feature. Document all screen(s) and every field, label, validation, message, and action. This is essentially the functional specification of the details of the screen(s) involved. Because it is in the context of the wireframe (next section), it is more concise. You can simply reference the field name, rather than verbosely state everything about the field. You can keep the details to field length, required, etc.

WIREFRAMES

A picture is required for each screen involved. Wireframes can be simple drawings on a whiteboard that are photographed, or a set of boxes created in Visio or OmniGraffle (or anything really). Some are photoshop-ed, and others are HTML. We have found that the best approach is HTML if that’s your end result. Recreating HTML that looks the exact same as a picture can be quite painful. Usually, a visual designer is involved in creating the mock ups, and can easily do this work in HTML. The developers can therefore take the exact HTML that is requested, and fill in their code as needed.


RESOURCES

SUGGESTED IMPLEMENTATION

Some code or pseudo-code


SUGGESTED TOOLS

PLUGINS, LIBRARIES, FRAMEWORKS, ETC
1.
2.
3.

REFERENCES


GLOSSARY

Another great idea

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

[B] A great idea

Is your feature request related to a problem?

Please describe A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]

Is your feature request an enhancement for existent feature? Which feature?

Describe the solution you'd like

A clear and concise description of what you want to happen.

Ex. As SOME ROLE, I want to DO SOMETHING, So that I CAN GET SOME BENEFIT
Add a phrase for each situation you considere

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.