This page is dedicated to the various parts of our project planning. This is the current version, you can find the last one here: Project Plan v2
Project Vision
For this project, my vision is to build a tool to allow me to manage the research data I have been generating, and will generate, while developing my business plan, as well as once I start putting the plan into motion. This tool should help create and manage a living business plan.
Project Goals
- G1: Reduce the amount of manual work required to create and manage data.
- G2: Enable easy export of data to various formats.
- G3: Create a business planner tool, automatically folding in data where it can.
- G4: [Stretch] Create a task planner, with the ability to link tasks back to specific parts of the business plan.
- G5: [Stretch] Integrate with ChatGPT to help with analysis and planning.
Objectives
G1: Reduce the amount of manual work required to create and manage data.
O1: Objective: Implement templates or predefined forms to standardize data input.
US1 – User Story
As a business owner, I want to create a custom form template based on my needs so that I can capture specific data unique to my workflow.
Acceptance Criteria
- Business owners can define fields and field types (e.g., text, number, dropdown).
- Templates can be saved and reused.
Requirements
- Business owners shall be able to change the name or description within the edit interface.
- Business owners shall be able to add, edit, and delete fields within the template.
- The system shall allow business owners to:
- Define field labels (what the form shows).
- Define field names (what the data is saved as).
- Specify field types (e.g., text, number, dropdown). Field types shall include at least:
- Text
- Number
- Dropdown
- Add, edit, re-order, and delete options for the dropdown
- Date
- Checkbox
- JSON block
- Re-order the defined fields
- Business owners shall be able to delete or clone the template from the edit interface
US1: Workflows
- Creating a template
Defining the metadata of a new template, including title and description. - Editing the template metadata
Changing the metadata for a template. - Editing the form fields in a template
Adding, editing, re-ordering, and deleting the fields in the form. - Editing the options of a form dropdown
Adding, editing, re-ordering, and deleting the options in a dropdown. - Saving changes to the template
Persisting all changes to a template. - Cloning a template
Duplicating a template, with a new name. - Deleting a template
Permanently removing a form template from the system.
Workflow: Creating A Template
Defining the metadata of a new template, including title and description.
Pre-Conditions
- The user must be logged in.
- The user must be a business owner.
Steps
- Click the button or link on the template list page to create a new template.
- Fill in the title.
- Click the button to save the template.
- If the title is not filled out, the form should display an error message and prevent the user from proceeding until it’s resolved.
Outcome
- The template is created.
- The user is sent to the list of templates, which should now include their new template.
- A notice will be displayed above the template list.
- This notice should contain the following:
- A confirmation of the creation.
- A link to the “Add Data” tool for the new template.
- A link to the “Edit Template” tool for the new template.
- This notice should contain the following:
US2 – User Story
As a user, I want to use a predefined form template so that I can ensure data is entered in a consistent format.
Acceptance Criteria
- The user can select the form from a list of all available templates.
- The list of templates shows when the template was created, as well as some statistics on usage.
Requirements
- The system should show a list of available templates for the user to browse.
- The list shall show:
- Template name
- Description
- Date created
- Date last used
- Number of records entered
- The user shall be able to select the template, and use it to enter new records.
- The user shall be able to select the template, to see what records have been entered.
- The list shall show:
US3 – User Story
As a business owner, I want to manage and update predefined templates so that outdated forms do not cause data inconsistencies.
Acceptance Criteria
- Business owners can edit, deactivate, or delete templates.
- Changes to templates do not affect existing data entries.
US4 – User Story
As a user, I want the system to auto-fill certain fields in the template based on previous entries so that I can save time on repetitive tasks.
Acceptance Criteria
- Auto-fill suggestions are based on the values entered previously in the session.
- Users can override auto-filled values manually.
US5 – User Story
As a business owner, I want to list, create, edit, and delete custom form templates based on my needs so that I can capture specific data unique to my workflow.
Acceptance Criteria
- Business owners can browse a list of active templates.
- Templates can be managed via the list interface, without having to use the edit interface.
Requirements
- The system shall provide an interface for business owners to create custom form templates. Each template will represent a type of data we can manage. The system shall allow business owners to:
- Name each template.
- View a list of saved templates.
- Edit or delete saved templates.
- Clone template to a new one. This will copy all field definitions as well.