-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modified some documents and added UserManual and VisionDocument
- Loading branch information
1 parent
6b545ed
commit b8bbaf1
Showing
5 changed files
with
26 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# **Project Plan** | ||
# Project Plan | ||
|
||
|
||
## 1. Introduction | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# DesignDocumentTemplates | ||
|
||
Design document templates in Markdown format. | ||
Light weight design document templates in Markdown format. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# User Manual | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Vision Document | ||
|
||
## 1. Introduction | ||
*In this section provide introductory details about the software (application, system, etc.). This can include where the inspiration for the initial idea originated.* | ||
|
||
## 2. Product / Solution Overview | ||
*In this section provide an overview of what solutions are provided by the software. Who is the target audience? How will the software help them? What are the expected improvements (time, efficiency, ease of access, etc) to be expected by the target audience?* | ||
|
||
## 3. Business Needs / Requirements | ||
*Provide here a list of the user requirements that software will solve. These can be brief descriptions of the requirements which can be built upon in a separate requirements document.* | ||
|
||
## 4. Major Features | ||
*Many applications or systems have multiple parts and features. Here describe briefly each of the major features that will provide the user with functionality.* | ||
|
||
## 5. Scope and Limitations | ||
*It is good to define a scope for software development to avoid excess feature drift and detect when potential redesign maybe needed due to an increasing scope. Also, list the limitations of the proposed architecture in order to identify some of the shortfalls of the proposed system.* |