Requirements-as-Code
Work with requirements the way developers work with code: as versioned text files in your repository, synchronized with Pidima.
- Keep requirements next to the code that implements them
- Review requirement changes in pull requests
- Round-trip changes between the repository and Pidima without losing traceability, links or history
Product Review Required
[PRODUCT REVIEW] This page requires additional technical details:
- Supported file format(s)
- Sync direction and conflict behaviour
- Setup steps
- One example file
Why Requirements-as-Code?
Traditional requirements management keeps requirements separate from implementation. Requirements-as-Code bridges this gap:
| Traditional Approach | Requirements-as-Code |
|---|---|
| Requirements in separate tool | Requirements live with code |
| Manual sync between systems | Automated synchronization |
| Review requirements separately | Review in same PR as code |
| Traceability maintained manually | Links preserved automatically |
How It Works
- Export: Requirements from Pidima can be exported as structured text files
- Version: Store requirement files in your Git repository alongside code
- Edit: Modify requirements using your preferred editor or IDE
- Review: Include requirement changes in pull requests for team review
- Sync: Changes flow back to Pidima, preserving traceability and history
Benefits
Developer-Friendly Workflow
- Edit requirements in familiar tools (VS Code, Vim, any text editor)
- Use Git branching for requirement changes
- Leverage existing code review processes
Complete Traceability
- Links between requirements and code remain intact
- History is preserved in both Git and Pidima
- No data loss during round-trip synchronization
Team Collaboration
- Review requirement changes alongside code changes
- Use PR comments to discuss requirements
- Maintain single source of truth with two-way sync
Getting Started
Setup and configuration details coming soon. Contact your Pidima account manager for early access to Requirements-as-Code features.
Related Documentation
- Sync/Unsync Requirements — How synchronization works in Pidima
- API Overview — Integration options
- Developer Quickstart — Getting started with the Pidima API