User stories - ESG-Project/documentation GitHub Wiki
This document contains all user stories for the Suassu environmental management system. The stories are organized by module and include their classification (MVP, Product, Evolution, Incremental) and current implementation status.
User Story Template and Approach
Each user story follows the standard format:
As a [role], I want to [action] so that [benefit]
Template Components:
- Role: Defines who wants the feature (e.g., technician, admin, finance manager)
- Action: Describes what the user wants to do
- Benefit: Explains why the user wants this feature (implicit in our stories)
Status Tracking:
- Completed: Feature is implemented and in production
- Pending: Feature is planned but not yet implemented
User Stories by Module
User Management
| ID | User Story | Status | Classification |
|---|---|---|---|
| US01 | As a user, I want to access and maintain my profile. | Completed | MVP |
| US02 | As an admin, I want to maintain users in my company. | Completed | MVP |
| US03 | As a technician, I want to maintain clients in my company. | Completed | MVP |
Project Management
| ID | User Story | Status | Classification |
|---|---|---|---|
| US04 | As a technician, I want to maintain projects for each client in my company. | Completed | MVP |
| US05 | As a technician, I want to maintain the map location for each project. | Completed | MVP |
Documental Management
| ID | User Story | Status | Classification |
|---|---|---|---|
| US06 | As a technician, I want to maintain environmental licenses for each project. | Completed | MVP |
| US07 | As a technician, I want to maintain conditions for each license. | Completed | MVP |
| US08 | As a technician, I want to maintain protocols for each project. | Completed | MVP |
| US09 | As a technician, I want to maintain official letters for each project. | Completed | MVP |
| US10 | As a technician, I want to maintain complements for each official letter. | Completed | MVP |
| US11 | As a technician, I want to receive email notifications about upcoming and pending deadlines related to my company's projects. | Completed | MVP |
| US12 | As a technician, I want to view a summary of upcoming and pending deadlines in the system. | Completed | Product |
System Administration
| ID | User Story | Status | Classification |
|---|---|---|---|
| US13 | As an admin, I want to maintain system parameters (e.g., vehicle fuel consumption, gasoline price, tax rate). | Completed | Product |
| US14 | As an admin, I want to maintain products offered by the company for commercial proposal completion. | Completed | Product |
| US25 | As an admin, I want to maintain product types offered by the company for commercial proposal completion. | Completed | Product |
Commercial Management
| ID | User Story | Status | Classification |
|---|---|---|---|
| US15 | As a technician, I want to maintain commercial proposals for each client. | Completed | Product |
| US16 | As a technician, I want to generate a commercial proposal document for each proposal to be sent to the client. | Completed | Product |
| US17 | As a technician, I want to mark commercial proposals as accepted or rejected. | Completed | Product |
Financial Management
| ID | User Story | Status | Classification |
|---|---|---|---|
| US18 | As a finance manager, I want to maintain financial transactions in the system (e.g., receivables, received amounts, and expenses). | Pending | Product |
| US19 | As a finance manager, I want to view a summary of current month's financial information. | Pending | Product |
| US20 | As a finance manager, I want to view a calendar with scheduled transactions for each day of the month. | Pending | Product |
| US21 | As a finance manager, I want to view a list of all company projects. | Pending | Product |
| US22 | As a finance manager, I want to access financial information for a specific project. | Pending | Product |
| US23 | As a finance manager, I want to generate financial transactions for each accepted commercial proposal. | Pending | Product |
Dashboard & Analytics
| ID | User Story | Status | Classification |
|---|---|---|---|
| US24 | As a technician, I want to view a dashboard with general statistical data about projects. | Pending | Incremental |
Phytosociological Analysis
| ID | User Story | Status | Classification |
|---|---|---|---|
| US25 | As a user, I want to create a new phytosociological analysis only from an existing project, filling in required fields (Title, Start Date, Number of Plots, Plot Area, Total Forest Area) so that I can correctly register a new forest inventory. The system must automatically calculate the Sampled Area, and require justification if manually changed. | Pending | Product |
| US26 | As a user, I want to view a list of analyses linked to a selected project, with key information (Title, Plots, Plot Area, Total Area, Sampled Area, Start Date), so that I can quickly access and manage them. The list must support search, ordering, pagination, and show a clear message if no results are found. | Pending | Product |
| US27 | As a user, I want to edit fields of an existing analysis (Title, Description, Date, Number of Plots, Plot Area, Total Area), so that I can update or correct information. The same validations from creation must apply, and changes require explicit confirmation. | Pending | Product |
| US28 | As a user, I want to permanently delete an analysis, with a required confirmation step, so that I can remove outdated or incorrect records. | Pending | Product |
| US29 | As a user, I want to access the "Species Data" tab of an active and selected analysis, so that I can start entering or importing specimen measurements. | Pending | Product |
| US30 | As a user, I want to add a new specimen by selecting its species (with real-time autocomplete), plot number or “Isolated”, and providing required measurements (Height and at least one CBH/CAP), so that I can accurately record tree data. The system must automatically calculate DAP and Basal Area. | Pending | Product |
| US31 | As a user, if a searched species is not found, I want to create a new one (Scientific Name and Family required, Popular Name optional) so that my workflow is not interrupted. As an administrator, I want to manage the complete species list (approve, edit, delete) ensuring consistency and uniqueness of Scientific Names. | Pending | Product |
| US32 | As a user, I want to import multiple specimens from an Excel or CSV file using a standard template, so that I can streamline large data entries. The system must validate file structure and values, report detailed errors, and allow importing valid rows while reviewing invalid ones. | Pending | Product |
| US33 | As a user, I want to view a paginated table of specimens for a selected analysis, with sortable columns (Plot, Species, Family, Avg CAP, Height, Date), so that I can verify the data entered. | Pending | Product |
| US34 | As a user, I want to click on a specimen to view its full details (Plot, Species, Height, CAPs, Date, Category), so that I can validate the record. | Pending | Product |
| US35 | As a user, I want to request changes to specific specimen fields (Species, Family, Height), providing a mandatory comment, so that I can correct or improve data. | Pending | Product |
| US36 | As an administrator, I want to view all specimen change requests with details (Specimen ID, Current vs Proposed Data, Requester, Date, Status, Comment), and filter them by status, user, or analysis. | Pending | Product |
| US37 | As an administrator, I want to approve or reject specimen change requests, requiring a reason for rejection, so that I can maintain data integrity. Approved requests must update calculations (DAP, Basal Area, Family if applicable) and register history. | Pending | Product |
| US38 | As a user, I want to access a consolidated dashboard for a selected analysis, displaying key indicators (Total Individuals, Total Species, Plots, Basal Area, Density, Volume, Diversity Indices, etc.) and graphical results (Phytosociological Parameters and Collector Curve), so that I can have a real-time overview of the analysis. | Pending | Product |
| US39 | As a user, I want the system to automatically calculate and display phytosociological parameters (Density, Dominance, Frequency, IVC, IVI, etc.) by species, so that I can perform detailed ecological analysis. | Pending | Product |
| US40 | As a user, I want to generate and view a detailed forest inventory table with specimen-level data and aggregated statistics (Mean, Std Dev, Variance, Sampling Error, CV, CI), so that I can validate results and prepare technical reports. The table must allow filters and column customization. | Pending | Product |
| US41 | As a user, I want to view consolidated results of Total Volume and Density in the Environmental Impact Assessment section, so that I can plan compensatory projects. | Pending | Product |
| US42 | As a user, I want the system to calculate and display environmental compensation and forest replacement obligations, so that I can comply with environmental legislation. | Pending | Product |
| US43 | As a user, I want to export reports, tables, and graphics in multiple formats (PDF, CSV, Excel, PNG, JPEG), and optionally download all project data in a ZIP file, so that I can share, present, and archive results. | Pending | Product |
Unspecified Epics
| User Story | Status | Classification |
|---|---|---|
| As a technician, I want to maintain feasibility studies for each project. | Pending | Evolution |
| As a technician, I want to maintain forest management for each project. | Pending | Evolution |
| As a technician, I want to maintain flora survey and monitoring for each project. | Pending | Evolution |
| As a technician, I want to maintain fauna survey and monitoring for each project. | Pending | Evolution |
| As a technician, I want to maintain documents for each project through links to an external public repository. | Pending | Evolution |
| As a technician, I want to maintain photographic records for each project. | Pending | Evolution |
| As a technician, I want to maintain Waste Transport Manifest (MTR) for each project. | Pending | Evolution |
| As a technician, I want to maintain topography for each project. | Pending | Evolution |
| As a technician, I want to maintain inspections for each project. | Pending | Evolution |
| As a technician, I want to exchange messages through the system. | Pending | Evolution |