Table of Contents - creq-0.2.11 Documentation
Pages
-
README.md.tt
- <%=config.capitalize%>
- How to start
- Git workflow
- contents
- creq.thor.tt
-
IEEE_830-1998
- IEEE Std 830-1998
- 1. Introduction
- 1.1 Purpose
- 1.2 Scope
- 1.3 Definitions, acronyms, and abbreviations
- 1.4 References
- 1.5 Overview
- 2. Overall description
- 2.1 Product perspective
- 2.1.1 System interface
- 2.1.2 User interfaces
- 2.1.3 Hardware interfaces
- 2.1.4 Software interfaces
- 2.1.5 Communications interfaces
- 2.1.6 Memory constraints
- 2.1.7 Operations
- 2.1.8 Site adaptation requirements
- 2.2 Product functions
- 2.3 User characteristics
- 2.4 Constraints
- 2.5 Assumptions and dependencies
- 2.6 Apportioning of requirements
- 3. Specific requirements
- 3.1 External interfaces
- 3.2 Functions
- 3.3 Performance requirements
- 3.4 Logical database requirements
- 3.5 Design constraints
- 3.5.1 Standards compliance
- 3.6 Software system attributes
- 3.6.1 Reliability
- 3.6.2 Availability
- 3.6.3 Security
- 3.6.4 Maintainability
- 3.6.5 Portability
- Appendixes
- Index
- 5.3.7 Organizing the specfic requirements
- 5.3.7.1 System mode
- 5.3.7.2 User class
- 5.3.7.3 Objects
- 5.3.7.4 Feature
- 5.3.7.5 Stimulus
- 5.3.7.6 Response
- 5.3.7.7 Functional hierarchy
-
RUP
- 0. Software Requirement Specification
- 1. Introduction
- 1.1 Purpose
- 1.2 Scope
- 1.3 Definitions, Acronyms, and Abbreviations
- 1.4 References
- 1.5 Overview
- 2. Overall Description
- 2.1 Product perspective
- 2.2 Product functions
- 2.3 User characteristics
- 2.4 Constraints
- 2.5 Assumptions and dependencies
- 2.6 Requirements subsets
- 2.7 General Requirements
- 2.8 Use-Case Model
- 3. Specific Requirements
- 3.1 Functionality
- 3.1.1 Functional Requirement One
- 3.2 Quality Requirements
- 3.2.1 Reliability
- 3.2.1.1 Maturity
- 3.2.1.2 Fault tolerance
- 3.2.1.3 Recoverability
- 3.2.1.4 Reliability compliance
- 3.2.2 Usability
- 3.2.2.1 Understandability
- 3.2.2.2 Learnability
- 3.2.2.3 Operability
- 3.2.2.4 Attractiveness
- 3.2.2.5 Usability compliance
- 3.2.3 Efficiency
- 3.2.3.1 Time behavior
- 3.2.3.2 Resource utilization
- 3.2.3.3 Efficiency compliance
- 3.2.3.4 Maintainability
- 3.2.3.5 Analyzability
- 3.2.3.6 Changeability
- 3.2.3.7 Stability
- 3.2.3.8 Testability
- 3.2.3.9 Maintainability compliance
- 3.2.4 Portability
- 3.2.4.1 Adaptability
- 3.2.4.2 Installability
- 3.2.4.3 Co-existence
- 3.2.4.4 Replaceability
- 3.2.4.5 Portability compliance
- 3.3 Design Constraints
- 3.3.1 Design Constraint One
- 3.4 On-line User Documentation and Help System Requirements
- 3.5 Purchased Components
- 3.6 Interfaces
- 3.6.1 User Interfaces
- 3.6.2 Hardware Interfaces
- 3.6.3 Software Interfaces
- 3.6.4 Communications Interfaces
- 3.7 Licensing Requirements
- 3.8 Legal, Copyright, and Other Notices
- 3.9 Applicable Standards
- 4. Supporting Information
- ears-with-examples
- feature
- raci-matrix
- solution-statement
- traceability
- use-case-templaes
- README
- promo.thor
- contents
- f.prj
- f.req
- f.rpo
- f.req.e
- f.req.f
- f.rpo.f
-
i.cli
- [i.cli] Command-line interface
- [.ver] Show version command
- [.hlp] Show commands
- [.hlp.cmd] Show help for a command
- [.new] New project command
- [.req] New requirement command
- [.chk] Check repository command
- [.toc] Build TOC command
- [.doc] Create output document command
- [.pub] Create output document in format command
- intro
- us.reader
- us.writer
- case.md.tt
- comp.md.tt
- ears.md.tt
- func.md.tt
- mins.md.tt
- story.md.tt
Classes and Modules
- Creq
- Creq::Cli
- Creq::DocWriter
- Creq::Helper
- Creq::ParamHolder
- Creq::Parser
- Creq::Project
- Creq::PubWriter
- Creq::Reader
- Creq::Repository
- Creq::ReqCommand
- Creq::Requirement
- Creq::Settings
- Creq::TreeNode
- Creq::Writer
- GraphVizBuilder
- Object
- Prioritizer
- Publicator
Methods
- ::build — GraphVizBuilder
- ::build_clustered — GraphVizBuilder
- ::call — Creq::DocWriter
- ::call — Creq::Parser
- ::call — Creq::Reader
- ::call — Creq::Repository
- ::call — Creq::ReqCommand
- ::call — Creq::Writer
- ::new — Creq::Reader
- ::new — Creq::Repository
- ::new — Creq::Requirement
- ::new — Creq::TreeNode
- ::new — Creq::Writer
- ::parse_attributes — Creq::Parser
- ::read_repo — Creq::Repository
- ::read_template_body — Creq::ReqCommand
- ::replace_macros — Creq::ReqCommand
- ::root — Creq
- ::source_root — Creq::Cli
- #<< — Creq::TreeNode
- #attributes — Creq::DocWriter
- #attributes — Creq::PubWriter
- #attributes — Creq::Writer
- #backup — Prioritizer
- #body — Creq::DocWriter
- #body — Creq::Writer
- #call — Prioritizer
- #capture_stdout — Object
- #capture_stdout — Creq::Helper
- #check_pandoc_installed — Creq::Helper
- #check_repo — Creq::Helper
- #chk — Creq::Cli
- #clustered_graph — GraphVizBuilder
- #create_doc — Creq::Helper
- #create_toc — Creq::Helper
- #doc — Creq::Cli
- #draft — Publicator
- #duplicate_ids — Creq::Repository
- #each — Creq::Requirement
- #each — Creq::TreeNode
- #each_req_text — Creq::Reader
- #expand_links! — Creq::Repository
- #find — Creq::Requirement
- #folders — Creq::Project
- #from_file — Prioritizer
- #from_repo — Prioritizer
- #generate_missing_ids — Creq::Repository
- #graph — GraphVizBuilder
- #id= — Creq::Requirement
- #init — Creq::Project
- #init_project — Creq::Helper
- #inside_bin — Creq::Helper
- #inside_src — Creq::Helper
- #item — Creq::Requirement
- #items — Creq::Requirement
- #level — Creq::TreeNode
- #link — Creq::DocWriter
- #link — Creq::PubWriter
- #links — Creq::Requirement
- #load — Creq::Repository
- #load — Creq::ParamHolder
- #merge — Prioritizer
- #new — Creq::Cli
- #output_doc_title — Creq::Helper
- #outputs — Publicator
- #pandoc — Creq::Helper
- #parameter — Creq::ParamHolder
- #parent= — Creq::TreeNode
- #parent_id — Creq::Requirement
- #promo — Creq::Cli
- #pub — Creq::Cli
- #publish — Publicator
- #put_according_to_level — Creq::Reader
- #query — Creq::Repository
- #query_repository — Creq::Helper
- #read — Creq::Reader
- #release — Publicator
- #repo_identifiers — Creq::Repository
- #repo_links — Creq::Repository
- #repo_requirements — Creq::Repository
- #req — Creq::Cli
- #requirements_repository — Creq::Helper
- #root — Creq::TreeNode
- #root? — Creq::TreeNode
- #save — Creq::ParamHolder
- #storage — Creq::ParamHolder
- #storage — Creq::Settings
- #store_files — Creq::Repository
- #subordinate! — Creq::Repository
- #system_attributes — Creq::Requirement
- #text — Creq::DocWriter
- #text — Creq::Writer
- #title — Creq::DocWriter
- #title — Creq::PubWriter
- #title — Creq::Writer
- #toc — Creq::Cli
- #up_verison! — Publicator
- #up_version — Publicator
- #url — Creq::DocWriter
- #user_attributes — Creq::Requirement
- #version — Creq::Cli
- #which — Creq::Helper
- #write — Creq::DocWriter
- #write — Creq::Writer
- #write — Prioritizer
- #wrong_links — Creq::Repository
- #wrong_order_index — Creq::Repository
- #wrong_parents — Creq::Repository