105 lines
2.0 KiB
Org Mode
105 lines
2.0 KiB
Org Mode
|
#+TITLE: Put the title of project here
|
||
|
|
#+AUTHOR: Rongsong Shen
|
||
|
|
#+EMAIL: shenrs@cn.ibm.com
|
||
|
|
#+OPTIONS: ^:{} H:3 LaTeX:t
|
||
|
|
#+STARTUP: showall
|
||
|
|
#+EXCLUDE_TAGS: hidden
|
||
|
|
#+LATEX_HEADER: \usepackage{tabularx}
|
||
|
|
|
||
|
|
#+LATEX: \usetikzlibrary{calc, shapes, backgrounds}
|
||
|
|
|
||
|
|
* DOCUMENT METADATA :hidden:
|
||
|
|
:PROPERTIES:
|
||
|
|
:THEME: mythemes
|
||
|
|
:REVIEWERS: Dog Wang
|
||
|
|
:VERSION: 1.0
|
||
|
|
:STATUS: Under Review
|
||
|
|
:CONTRIBUTORS:
|
||
|
|
:TYPE: Functional Specification
|
||
|
|
:END:
|
||
|
|
|
||
|
|
#+NAME: document-history
|
||
|
|
|-----+-------------+---------------+-----------------|
|
||
|
|
| 1.0 | Jul 17,2016 | Rongsong Shen | Initial version |
|
||
|
|
|-----+-------------+---------------+-----------------|
|
||
|
|
|
||
|
|
* Introduction
|
||
|
|
|
||
|
|
** Purpose
|
||
|
|
|
||
|
|
This Detailed Requirement Specification is to be used as a guide
|
||
|
|
for the design and verification of the \textcolor{blue}{\projname}
|
||
|
|
for \textcolor{blue}{\productname} product release
|
||
|
|
\textcolor{blue}{\productversion} . This document should be
|
||
|
|
detailed enough to allow the creation of high level design
|
||
|
|
documents, test cases and customer documentation. It is intended
|
||
|
|
for the internal use of Product Management, Development, QA,
|
||
|
|
Documentation, Professional Services, Support, and agents of IBM.
|
||
|
|
|
||
|
|
** Definitions, Acronyms, Buzzwords And Abbreviations
|
||
|
|
|
||
|
|
|
||
|
|
* Specifications
|
||
|
|
|
||
|
|
** Functional Requirements
|
||
|
|
|
||
|
|
*** Summary
|
||
|
|
|
||
|
|
*** Context
|
||
|
|
|
||
|
|
*** Scope
|
||
|
|
|
||
|
|
1. Scope
|
||
|
|
|
||
|
|
2. Out Of Scope
|
||
|
|
|
||
|
|
*** Assumptions and Dependencies
|
||
|
|
|
||
|
|
*** Functional Description
|
||
|
|
|
||
|
|
1. Detail Functional Description
|
||
|
|
|
||
|
|
2. Interactions
|
||
|
|
|
||
|
|
3. Criteria
|
||
|
|
|
||
|
|
*** Interface Requirements
|
||
|
|
|
||
|
|
1. Command line
|
||
|
|
2. Configuration
|
||
|
|
3. Events File Changes
|
||
|
|
4. API Requirements
|
||
|
|
5. Installation
|
||
|
|
6. PERF Requirement
|
||
|
|
7. Licensing Requirements
|
||
|
|
8. Multi-head Consideration
|
||
|
|
9. ID Requirement
|
||
|
|
|
||
|
|
** Use Cases
|
||
|
|
|
||
|
|
** Non-Functional Requirements
|
||
|
|
|
||
|
|
*** Time, Performance and Throughput
|
||
|
|
|
||
|
|
*** Scalability
|
||
|
|
|
||
|
|
*** Robustness, Reliability and Recovery
|
||
|
|
|
||
|
|
*** Platform(s) Configuration
|
||
|
|
|
||
|
|
*** 3rd Party and External Applications
|
||
|
|
|
||
|
|
*** Administration and Supportability
|
||
|
|
|
||
|
|
*** Security
|
||
|
|
|
||
|
|
*** Migration and Compatibility
|
||
|
|
|
||
|
|
|
||
|
|
* References
|
||
|
|
|
||
|
|
|
||
|
|
# Local Variables:
|
||
|
|
# End:
|
||
|
|
|