Example Application
This is a short description of the purpose or use case of the application.
Getting started
Installation
Download the binary from XYZ:
curl ...
Configuration
Optional chapter to describe basic configuration required and a link to more detailed description.
Execution
Run the following command to perform some action:
/bin/bash echo "Hello"
User Manual
Detailed description or links to the resources.
- Setup recommendations
- Production guide
- API documentation
- CLI documentation ...
Changelog
- Link to releases. Eg: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases
- Know limitations within releases
Contribution
Bug tracking and planing
- Link to Jira, Github issues ...
Requirements
- List of basic requirements or link.
Architecture
- Overview
- Design decisions
Development
- Link to sources and artifacts
- Coding Guidelines
Verification
- Coverage
- Traceability
CI/CD
- Build instructions
- Deployment instructions