187 lines
5.4 KiB
Org Mode
187 lines
5.4 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,mythemes}
|
|
|
|
#+LATEX: \usetikzlibrary{calc, shapes, backgrounds}
|
|
|
|
#+BEGIN_LaTeX
|
|
\newcommand\projname{Put Project Name Here}
|
|
\newcommand\projid{}
|
|
\newcommand\productname{LSF}
|
|
\newcommand\productversion{9.2}
|
|
\newcommand\docname{\projname}
|
|
\newcommand\docversion{0.1}
|
|
\newcommand\docstatus{Under Review}
|
|
\newcommand\doctype{Functional Specification}
|
|
\newcommand\docauthor{Rongsong Shen}
|
|
\newcommand\docupdate{\today}
|
|
\newcommand\contributors{}
|
|
\newcommand\docreviewers{}
|
|
\newcommand\circulation{Confidential, for internal use only}
|
|
\newcommand\docdescription{Add description here}
|
|
#+END_LaTeX
|
|
|
|
#+BEGIN_LATEX
|
|
\begin{coverpage}{ibm-logo.png}
|
|
% BEGIN RECEIVE ORGTBL docinfo
|
|
% END RECEIVE ORGTBL docinfo
|
|
\begin{copyrightnotice}
|
|
The materials contained herein are proprietary to Platform Computing and
|
|
are presented in draft form for the purposes of your review and
|
|
comment. By providing your comments and suggestions to Platform
|
|
Computing, you acknowledge that the intellectual property rights in
|
|
these materials and in your comments and suggestions regarding the
|
|
materials shall vest in and remain the exclusive property of Platform
|
|
Computing, for use by Platform Computing in its sole discretion and
|
|
without attribution as to the source of any comments or suggestions
|
|
received. These materials are not in a final form and are not
|
|
intended to be relied upon by you and you specifically affirm that you
|
|
will not rely on any statement contained in the materials as being a
|
|
definitive position, opinion or statement of Platform Computing. The
|
|
trademarks and registered trademarks contained herein are the property
|
|
of their respective owners.
|
|
\end{copyrightnotice}
|
|
|
|
\begin{confidential}
|
|
Platform Computing Confidential
|
|
- No part of this document may be reproduced, copied or distributed
|
|
in any fashion without the express written permission of Platform Computing Corporation.\\
|
|
\end{confidential}
|
|
|
|
\end{coverpage}
|
|
\ibmpagestyle
|
|
\begin{projectinfo}
|
|
% BEGIN RECEIVE ORGTBL projectinfo
|
|
% END RECEIVE ORGTBL projectinfo
|
|
\end{projectinfo}
|
|
|
|
\begin{dochistory}
|
|
% BEGIN RECEIVE ORGTBL dochistory
|
|
% END RECEIVE ORGTBL dochistory
|
|
\end{dochistory}
|
|
#+END_LATEX
|
|
|
|
\newpage
|
|
#+LATEX: \tableofcontents
|
|
\newpage
|
|
|
|
* Setup information :hidden:
|
|
#+ORGTBL: SEND docinfo orgtbl-to-latex :splice nil :skip 0
|
|
| *Document Name:* | \docname |
|
|
| *Document Version:* | \docversion |
|
|
| *Document Status:* | \docstatus |
|
|
| *Document Type:* | \doctype |
|
|
| *Document Author:* | \docauthor |
|
|
| *Last Updated:* | \docupdate |
|
|
|
|
|
|
#+ORGTBL: SEND projectinfo orgtbl-to-latex :splice t :skip 0
|
|
|-----------------------+--------------------------|
|
|
| *Author* | \docauthor \contributors |
|
|
|-----------------------+--------------------------|
|
|
| *Reviewers* | \docreviewers |
|
|
|-----------------------+--------------------------|
|
|
| *Circulation* | \circulation |
|
|
|-----------------------+--------------------------|
|
|
| *Project Name* | \docname \projname |
|
|
|-----------------------+--------------------------|
|
|
| *Project No* | \projid |
|
|
|-----------------------+--------------------------|
|
|
| *Project Description* | \docdescription |
|
|
|-----------------------+--------------------------|
|
|
|
|
|
|
#+ORGTBL: SEND dochistory orgtbl-to-latex :splice t :skip 0
|
|
|-----+------------+------------+----------------------------|
|
|
| 0.2 | \today | \docauthor | using \TeX{}4ht to convert |
|
|
| | | | document to other formats |
|
|
|-----+------------+------------+----------------------------|
|
|
| 0.1 | Feb 2,2015 | \docauthor | 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:
|
|
# org-latex-title-command: "\\relax"
|
|
# org-latex-toc-command: "\\relax"
|
|
# End:
|
|
|