Table of Contents - clerq-0.3.4 Documentation
Pages
-
SRS-IEEE-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
-
SRS-RUP
- 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
-
business-case
- Business Case
- What is a business case?
- How to Write a Business Case
- Template
- Executive Summary
- Finance
- Project Definition
- Business Objective
- Benefits and Limitations
- Option Identification and Selection
- Scope, Impact, and interdependencies
- Outline Plan
- Market Assessment
- Risk assessment
- Project Approach
- Purchasing Strategy
- Project Organization
- ears-with-examples
- problem-statement
- product-statement
- requirement-attributes
- requirement-classification
- requirement-life-cycle
- requirement-quality
- use-case
-
vision-document
- Revision History
- Table of Contents
- 1 Introduction
- 1.1 Purpose
- 1.2 Solution Overview
- 1.3 References
- 2 User Description
- 2.1 User/Market Demographics
- 2.2 User Personas
- 2.3 User Environment
- 2.4 Key User Needs
- 2.5 Alternatives and Competition
- 2.5.1 Competitor 1
- 2.5.2 Competitor 2
- 3 Stakeholders
- 4 Product Overview
- 4.1 Product Perspective
- 4.2 Product Position Statement
- 4.3 Summary of Capabilities
- 4.4 Assumptions and Dependencies
- 4.5 Cost and Pricing
- 5 Product Features
- 5.1 Feature 1
- 5.2 Feature 2
- 6 Exemplary Use Cases
- 7 Nonfunctional Requirements
- 7.1 Usability
- 7.2 Reliability
- 7.3 Performance
- 7.4 Supportability
- 7.5 Other Requirements
- 7.5.1 Applicable Standards
- 7.5.2 System Requirements
- 7.5.3 Licensing, Security, and Installation
- 8 Documentation Requirements
- 8.1 User Manual
- 8.2 Online Help
- 8.3 Installation Guides, Configuration, “Read Me” File
- 8.4 Labeling and Packaging
- 9 Glossary
- clerq_doc.thor
- README.md.tt
- clerq.thor.tt
- clerq.yml.tt
- content.md.tt
- README
-
Clerq SRS
- Introduction
- Purpose
- Scope
- Definitions, acronyms, and abbreviations
- References
- Overview
- User stories
- Reader
- Presentation format
- Writer
- README, HOW-TO
- Write in plain text files
- Using of lightweight markup language
- Set of separate files
- Requirements subordination and order
- Supporting Metadata
- Supporting Links
- Requirements templates
- Checking repository
- Querying requirements
- Combining into documents
- Providing unique identifiers
- Document templates
- Create own document template
- Script automation
- Functional requirements
- Components
- Node
- Read node from markup text
- Write node to markup text
- Repository
- Read repository
- Query repository
- Templates manager
- Find template
- Writer
- Write function
- Entities
- Node entity
- System node options
- Template entity
- User Interface
- CLI
- Project settings
- Getting version
- Help
- Input parameters
- .01
- Creating new project
- Input parameters
- .01
- .02
- Checking project
- .01
- .02
- Building project
- Input parameters
- .01
- .02
- .03
- .04
- .05
- Appendix
- promo.thor
- clerq
- cmp.node
- cmp.repo
- cmp.tt
- cmp.writer
- ent
- cli.bld
- cli.chk
- cli.hlp
- cli.new
- cli.opt
- cli.ver
- ui.cli
- us.reader
-
us.writer
- [.writer] Writer
- README, HOW-TO
- Write in plain text files
- Using of lightweight markup language
- Set of separate files
- Requirements subordination and order
- Supporting Metadata
- Supporting Links
- Requirements templates
- Checking repository
- Querying requirements
- Combining into documents
- Providing unique identifiers
- Document templates
- Create own document template
- Script automation
Classes and Modules
- Clerq
- Clerq::Cli
- Clerq::Entities
- Clerq::Entities::Clerq
- Clerq::Entities::Clerq::Entities
- Clerq::Entities::Clerq::Entities::Clerq
- Clerq::Entities::Clerq::Entities::Clerq::Entities
- Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- Clerq::Error
- Clerq::Properties
- Clerq::Repositories
- Clerq::Repositories::FileRepository
- Clerq::Repositories::NodeRepository
- Clerq::Repositories::TextRepository
- Clerq::Services
- Clerq::Services::CheckAssembly
- Clerq::Services::CreateNode
- Clerq::Services::LoadAssembly
- Clerq::Services::QueryNode
- Clerq::Services::QueryTemplate
- Clerq::Services::ReadNode
- Clerq::Services::RenderErb
- Clerq::Services::RenderNode
- Clerq::Services::Service
- Clerq::Settings
- ColonizeRepo
- EvalMacro
- FakeWriter
- ListMacro
- MarkupMacro
- MarkupNode
- Object
- SkipMacro
- TreeMacro
Methods
- ::assemble — Clerq
- ::bin — Clerq
- ::call — Clerq::Services::Service
- ::document — Clerq
- ::exit_on_failure? — Clerq::Cli
- ::new — ColonizeRepo
- ::new — SkipMacro
- ::new — EvalMacro
- ::new — ListMacro
- ::new — TreeMacro
- ::new — FakeWriter
- ::new — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- ::new — Clerq::Repositories::FileRepository
- ::new — Clerq::Repositories::NodeRepository
- ::new — Clerq::Repositories::TextRepository
- ::new — Clerq::Services::CheckAssembly
- ::new — Clerq::Services::CreateNode
- ::new — Clerq::Services::QueryNode
- ::new — Clerq::Services::QueryTemplate
- ::new — Clerq::Services::ReadNode
- ::new — Clerq::Services::RenderErb
- ::new — Clerq::Services::RenderNode
- ::new — Clerq::Settings
- ::node_repository — Clerq
- ::node_repository= — Clerq
- ::reset — Clerq
- ::root — Clerq
- ::settings — Clerq
- ::source_root — Clerq::Cli
- ::src — Clerq
- ::template — Clerq
- ::text_repository — Clerq
- ::text_repository= — Clerq
- ::title — Clerq
- ::tt — Clerq
- #<< — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #assemble — Clerq::Repositories::NodeRepository
- #body — MarkupNode
- #build — Clerq::Cli
- #call — ColonizeRepo
- #call — Clerq::Services::CheckAssembly
- #call — Clerq::Services::CreateNode
- #call — Clerq::Services::LoadAssembly
- #call — Clerq::Services::QueryNode
- #call — Clerq::Services::QueryTemplate
- #call — Clerq::Services::ReadNode
- #call — Clerq::Services::RenderErb
- #call — Clerq::Services::RenderNode
- #call — Clerq::Services::Service
- #check — Clerq::Cli
- #check! — Clerq::Repositories::NodeRepository
- #check_string_argument! — Clerq::Services::RenderNode
- #check_string_empty! — Clerq::Services::RenderNode
- #clerq_project? — Clerq::Cli
- #each — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #eqid! — Clerq::Repositories::NodeRepository
- #filename — ColonizeRepo
- #find — Clerq::Repositories::TextRepository
- #folder — ColonizeRepo
- #folders — Clerq::Settings
- #glob — Clerq::Repositories::FileRepository
- #how_many_times — Clerq::Services::CheckAssembly
- #id — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #insert_node — Clerq::Services::ReadNode
- #inside — Clerq::Repositories::FileRepository
- #item — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #items — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #link — MarkupNode
- #links — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #load — Clerq::Repositories::NodeRepository
- #load — Clerq::Settings
- #lost_links — Clerq::Services::CheckAssembly
- #markup — MarkupNode
- #markup — Clerq::Repositories::NodeRepository
- #meta — MarkupNode
- #nesting_level — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #new — Clerq::Cli
- #node — Clerq::Cli
- #node — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #nonuniq_id — Clerq::Services::CheckAssembly
- #nos — Clerq::Services::LoadAssembly
- #order_index — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #orphan! — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #parent= — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #parse_meta — Clerq::Services::ReadNode
- #parse_node — Clerq::Services::ReadNode
- #prepare_query — Clerq::Services::QueryNode
- #print_lost_index — Clerq::Services::CheckAssembly
- #print_lost_links — Clerq::Services::CheckAssembly
- #print_lost_roots — Clerq::Services::CheckAssembly
- #print_nonuniq_id — Clerq::Services::CheckAssembly
- #process — MarkupMacro
- #process — SkipMacro
- #process — EvalMacro
- #process — ListMacro
- #process — TreeMacro
- #process_links! — MarkupNode
- #process_macro! — MarkupNode
- #promo — Clerq::Cli
- #property — Clerq::Properties
- #query_assembly — Clerq::Cli
- #read — Clerq::Repositories::FileRepository
- #read_nodes — Clerq::Services::ReadNode
- #root — Clerq::Entities::Clerq::Entities::Clerq::Entities::Node
- #ruby_class_name — Clerq::Cli
- #save — Clerq::Repositories::NodeRepository
- #save — Clerq::Settings
- #source — ColonizeRepo
- #stop! — Clerq::Cli
- #stop_unless_clerq! — Clerq::Cli
- #subo! — Clerq::Repositories::NodeRepository
- #text — ColonizeRepo
- #text — Clerq::Repositories::TextRepository
- #thor_filename — Clerq::Cli
- #title — MarkupNode
- #toc — Clerq::Cli
- #url — MarkupNode
- #version — Clerq::Cli
- #write — ColonizeRepo
- #write — Clerq::Repositories::FileRepository