System use case specification generate and export commercial proposal - ESG-Project/documentation GitHub Wiki

← Home / Requirements / System Use Cases / System Use Cases Specification

Identification UC16
Use case Generate and export commercial proposal
Actors Administrator, Technician
Stakeholders and interests Consulting company: Ability to generate a comprehensive commercial proposal document and export it for sharing with clients.
Pre-conditions User is logged into the system as an administrator or technician; System has access to the saved proposal details in the database.
Minimum guarantees System generates a proposal document without errors.
Success guarantees User successfully generates and exports a commercial proposal document.

Main Success Scenario

User Action System Response
1. This use case begins when the user selects a completed proposal to generate the document 2. The system retrieves the details of the selected proposal from the database
3. The system compiles the proposal details into a comprehensive document format (e.g., PDF, DOCX)
4. The system provides an option for the user to download or export the generated document
5. The user downloads or exports the proposal document 6. The system confirms the successful generation and export of the document

Alternative Flows

3a Error during document generation

User Action System Response
1. The system detects an error in generating the document
2. The system displays an error message to the user
3. The user retries the generation process 4. The system returns to step 2 of the Main Success Scenario

5a User cancels the export action

User Action System Response
1. The user cancels the export action 2. The system returns to the proposal details page without generating the document

5b Document format selection

User Action System Response
1. The user selects a specific document format (PDF/DOCX) 2. The system generates the document in the selected format
3. The system provides the download option for the selected format

Special Requirements

  • Document Format: The system must support export in common formats (PDF, DOCX).
  • Proposal Details: The document must include all relevant details of the proposal, formatted clearly and professionally.
  • Template System: The system must use a professional template for proposal generation.
  • Company Branding: Generated documents must include company logo and branding elements.
  • Preview Option: Users must be able to preview the document before export.
  • Access Control: Only authorized users can generate and export proposals.