Doorstop Text-based requirements management using version control. Jace Browning Advisor: Dr. Robert Adams 

Outline ● Introduction ● Required Features ● Existing Solutions ● Doorstop Model ● Implementation Details ● Future Work 

Introduction ● What is a “requirement”? ○ Uniquely identified block of text ○ Contains a “shall” statement ○ Metadata: type, author, notes, etc. ○ Links to other requirements ● Applications: ○ Aerospace, medical, automotive, etc. 

Introduction ● Other linkable items: ○ Test cases and procedures ○ Source code modules and functions ● Collections of items form documents: ○ Outline organization ○ Parent-child relationship 

Sample Items in Documents 

Sample Linking Hierarchy 

Introduction (cont.) ● What is “requirements management”? ○ Requirements decomposition ○ Test coverage ○ Traceability review ● Requirements management tools help: ○ Create, edit, and link items ○ Present and export documents ○ Store and provide access 

Required Features ● Composition: ○ Unique, permanent IDs for items ○ Linkable sections of text ○ Formatted text ○ External references ○ Expandable interfaces 

Required Features ● Presentation: ○ Standard users: ■ documents ■ link tables ○ Advanced users: ■ filters ■ queries ■ scripts ○ Auditable trail of baselines 

Required Features ● Administration: ○ Permanent and secure storage ○ Change management = request and review ○ Connection to existing accounts ○ Scaleable: ■ document size ■ user base ○ Lightweight installation 

Existing Solutions ● Centralized: ○ GUI with editable columns of text ○ Stored as database entries ○ Options: DOORS, Dimensions, Integrity, OSRMT ○ Disadvantages: ■ licensing costs ■ proprietary scripting interfaces ■ limited connection to source code 

Existing Solutions ● Cloud-based: ○ Cleaner, modern web interfaces ○ Offsite storage of document histories ○ Options: Accompa, Jama, aNimble Platform ○ Disadvantages: ■ 3rd-party hosting restrictions ■ limited scripting interfaces ■ disconnected from source code 

Existing Solutions ● Decentralized: ○ Store requirements as files ○ Typically command-line interfaces ○ Options: rmtoo ○ Disadvantages: ■ complex installations ■ harder for non-technical users ■ limited cross-platform support 

Doorstop Model ● Text files stored in version control ● “Item Files” ○ Linkable text (requirement, test case, etc.) ○ External references ○ Assigned unique and sequential file name ● “Document Directories” ○ Contain related item files ○ Parent-child relationship between documents 

Doorstop’s Requirements Model 

Doorstop Model (cont.) ● Role of the tool: ○ Create document directories and item files ○ Add and remove links between item files ○ Format the contents of item files ○ Validate the document hierarchy and contents ○ Export text for presentation purposes 

Doorstop Model (cont.) ● Role of the version control system (VCS): ○ Stores the item files: commit ○ Manages the history of requirements ○ Creates baselines of requirements: tag ○ Handles changes under review: branch/merge ○ Associates changes with existing users ○ Shows line differences between versions: diff ○ Provides offline access with a distributed VCS 

Implementation Details ● Python 3 ● YAML ○ Human-readable, machine-parsable ○ Line-based ● Markdown ○ Presentable as pure text ○ Converts to a variety of formats 

Sample Project Structure 

Sample Item File 

Sample Item File with External References 

Command-line Interface 

Scripting Interface 

Future Work ● Full-scale trial ● GUI written in Python ● More document presentation formats ● Import and export to common formats 

Questions?