109 lines
6.5 KiB
Markdown
109 lines
6.5 KiB
Markdown
# Requirements Document
|
|
|
|
## Introduction
|
|
|
|
This specification defines the requirements for renaming the "Deleted Items Management" feature to "Recovery Management" throughout the VFX Project Management System. This change improves the user experience by using more positive, action-oriented terminology that focuses on recovery capabilities rather than deletion.
|
|
|
|
## Glossary
|
|
|
|
- **Recovery Management**: The administrative interface for viewing and recovering soft-deleted items (shots and assets)
|
|
- **Soft Deletion**: The process of marking items as deleted without permanently removing them from the database
|
|
- **Recovery Interface**: The user interface components that allow administrators to restore deleted items
|
|
- **Navigation Menu**: The sidebar navigation system that provides access to different application sections
|
|
- **Admin Panel**: The administrative section of the application restricted to admin users
|
|
|
|
## Requirements
|
|
|
|
### Requirement 1
|
|
|
|
**User Story:** As an administrator, I want the navigation menu to show "Recovery Management" instead of "Deleted Items" so that the interface uses more positive terminology.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN an administrator views the admin navigation menu THEN the system SHALL display "Recovery Management" instead of "Deleted Items"
|
|
2. WHEN the navigation item is clicked THEN the system SHALL navigate to the recovery management interface
|
|
3. WHEN the URL is accessed directly THEN the system SHALL maintain the same route path for backward compatibility
|
|
4. WHEN the page loads THEN the system SHALL display the updated terminology consistently
|
|
|
|
### Requirement 2
|
|
|
|
**User Story:** As an administrator, I want the page title and headers to reflect "Recovery Management" terminology so that the interface is consistent and user-friendly.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN the recovery management page loads THEN the system SHALL display "Recovery Management" as the main page title
|
|
2. WHEN viewing the page description THEN the system SHALL use recovery-focused language instead of deletion-focused language
|
|
3. WHEN loading states are shown THEN the system SHALL display "Loading recovery data..." instead of "Loading deleted items..."
|
|
4. WHEN no items are found THEN the system SHALL display "No items available for recovery" instead of "No deleted items found"
|
|
5. WHEN displaying summary statistics THEN the system SHALL use "Items Available for Recovery" terminology
|
|
|
|
### Requirement 3
|
|
|
|
**User Story:** As an administrator, I want all user interface text to use recovery-focused language so that the system feels more positive and action-oriented.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN viewing filter labels THEN the system SHALL use "Recovery Filters" instead of "Deleted Items Filters"
|
|
2. WHEN displaying item counts THEN the system SHALL show "Items Available for Recovery" instead of "Deleted Items"
|
|
3. WHEN showing empty states THEN the system SHALL display recovery-focused messaging
|
|
4. WHEN displaying error messages THEN the system SHALL use recovery terminology in error descriptions
|
|
5. WHEN showing success messages THEN the system SHALL maintain recovery-focused language
|
|
|
|
### Requirement 4
|
|
|
|
**User Story:** As a developer, I want the component and file names to remain unchanged so that existing functionality and references are preserved.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN reviewing the codebase THEN the system SHALL maintain existing file names and component names
|
|
2. WHEN accessing API endpoints THEN the system SHALL preserve existing endpoint paths and functionality
|
|
3. WHEN viewing route configurations THEN the system SHALL maintain existing route paths for backward compatibility
|
|
4. WHEN examining service methods THEN the system SHALL preserve existing method names and interfaces
|
|
5. WHEN checking database schemas THEN the system SHALL maintain existing table and column names
|
|
|
|
### Requirement 5
|
|
|
|
**User Story:** As a system administrator, I want the browser tab title to reflect the new terminology so that the interface is consistent across all touchpoints.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN the recovery management page is active THEN the browser tab SHALL display "Recovery Management" in the title
|
|
2. WHEN bookmarking the page THEN the bookmark SHALL use the updated terminology
|
|
3. WHEN sharing the page URL THEN the page title SHALL reflect the recovery management terminology
|
|
4. WHEN the page is indexed by search engines THEN the title SHALL use the updated terminology
|
|
|
|
### Requirement 6
|
|
|
|
**User Story:** As an administrator, I want to permanently delete soft-deleted items from the database so that I can free up storage space and permanently remove unwanted data.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN viewing soft-deleted items THEN the system SHALL provide a "Permanent Delete" action for each item
|
|
2. WHEN selecting multiple soft-deleted items THEN the system SHALL provide a bulk permanent delete option
|
|
3. WHEN initiating permanent deletion THEN the system SHALL show a confirmation dialog warning about data loss
|
|
4. WHEN confirming permanent deletion THEN the system SHALL remove the item and all related data from the database
|
|
5. WHEN permanent deletion completes THEN the system SHALL show a success message and remove the item from the recovery list
|
|
|
|
### Requirement 7
|
|
|
|
**User Story:** As an administrator, I want permanent deletion to remove all related data so that no orphaned records remain in the database.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN permanently deleting a shot THEN the system SHALL remove all associated tasks, submissions, attachments, notes, and reviews
|
|
2. WHEN permanently deleting an asset THEN the system SHALL remove all associated tasks, submissions, attachments, notes, and reviews
|
|
3. WHEN permanently deleting items THEN the system SHALL remove all associated activity records
|
|
4. WHEN permanent deletion occurs THEN the system SHALL delete all associated files from the file system
|
|
5. WHEN permanent deletion completes THEN the system SHALL ensure no foreign key references remain
|
|
|
|
### Requirement 8
|
|
|
|
**User Story:** As an administrator, I want permanent deletion to be irreversible and secure so that sensitive data is properly removed.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN permanent deletion is confirmed THEN the system SHALL immediately remove data from the database
|
|
2. WHEN files are permanently deleted THEN the system SHALL remove them from the file system
|
|
3. WHEN permanent deletion occurs THEN the system SHALL log the action for audit purposes
|
|
4. WHEN permanent deletion fails THEN the system SHALL rollback all changes and show an error message
|
|
5. WHEN permanent deletion completes THEN the system SHALL ensure the action cannot be undone |