Modified some documents and added UserManual and VisionDocument

imayobrown · Aug 10, 2015 · b8bbaf1 · b8bbaf1
1 parent 6b545ed
commit b8bbaf1
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/DesignDocument.md b/DesignDocument.md
@@ -1,8 +1,8 @@
 # Design Document
 
-**Author**: Ian Brown
 
-## 1 Design Considerations
+## 1. Design Considerations
+
 
 ### 1.1 Assumptions
 
@@ -15,7 +15,7 @@
 ### 1.3 System Environment
 
 
-## 2 Architectural Design
+## 2. Architectural Design
 
 
 ### 2.1 Component Diagram
@@ -24,7 +24,7 @@
 ### 2.2 Deployment Diagram
 
 
-## 3 Low-Level Design
+## 3. Low-Level Design
 
 
 ### 3.1 Class Diagram

diff --git a/ProjectPlan.md b/ProjectPlan.md
@@ -1,4 +1,4 @@
-# **Project Plan**
+# Project Plan
 
 
 ## 1. Introduction 

diff --git a/README.md b/README.md
@@ -1,3 +1,3 @@
 # DesignDocumentTemplates
 
-Design document templates in Markdown format.
+Light weight design document templates in Markdown format.
diff --git a/UserManual.md b/UserManual.md
@@ -0,0 +1,4 @@
+# User Manual
+
+
+
diff --git a/VisionDocument.md b/VisionDocument.md
@@ -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.*