Selection tool for letter templates
- Dominant language
- Python
- Stars
- 8
- Forks
- 2
- Avg merge
- 14h 34m
- Merged PRs (30d)
- 46
Description
* As an analyst
* I want to select from letter templates
* so that I can attach them to my correspondence email
**Dependencies? What is the impact of this dependency? (If so, link dependency in the ticket, make it visible in a team´s backlog)**
#104, #353
Material UI Rich text editor?
**Assumptions & Scope**
What are the assumptions for this story?
This does not include the template design
Does the analyst need to attach more than 1 letter?
Does the analyst need to be able to delete the letter or can they cancel the correspondence?
This does NOT include editing the Letter in the rich text editor, and generating the request specific details into the Letter template.
What is in and not in scope?
**Acceptance Criteria**
**Scenario 1: Open Select Templates**
* GIVEN an analyst is on the Contact Applicant view:
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
* WHEN the analyst clicks the 'ComposeTemplate' button
* THEN a modal will open with a range of templates:
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
*AND the templates will be listed alphabetically (how many templates do we have?)
*AND the date each template was uploaded will be shown
**Scenario 2: Close Select Templates**
* GIVEN an analyst is on the Select Template modal:
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
* WHEN the analyst clicks the 'X' or the 'Return to Correspondence'
* THEN the analyst will return to the Contact Applicant view:
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
**Scenario 3: Select Template**
* GIVEN an analyst is on the Select Template modal:
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
* WHEN the analyst clicks a box next to the name of the letter template
* THEN the 'Create Correspondence' button will become active and turn blue
**Scenario 4: Create Letter**
* GIVEN an analyst has selected a template
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpq1chy600py011q06um2n6f/play
* WHEN the analyst clicks the 'Create Letters' button
* THEN the analyst will be redirected to the Contact Applicant view
* AND the selected template will be attached to the correspondence in the 'Add File' section
* https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
**Scenario 5: View Letter**
* GIVEN a file has been attached to correspondence
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
* WHEN the analyst clicks on the letter title in the 'Add File' section
* THEN the letter will be opened in a rich text editor
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
**Scenario 6: Close Letter**
* GIVEN an analyst has opened a letter
https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
* WHEN the analyst clicks the 'X'
* THEN the letter will close
* AND the analyst will be on the correspondence
* https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
**Validation Rules? (If yes, list here)**
**Design**
@xxx - please link the Design here
**Definition of Ready**
1. [ ] Is there a well articulated User Story?
2. [ ] Is there Acceptance Criteria that covers all scenarios (happy/sad paths)?
3. [ ] If there is a user interface, is there a design?
4. [ ] Does the user story need user research/validation?
5. [ ] Does this User Story needs stakeholder approval?
6. [ ] Design / Solution accepted by Product Owner
7. [ ] Is this user story small enough to be completed in a Sprint? Should it be split?
8. [ ] Are the dependencies known/ understood? (technical, business, regulatory/policy)
9. [ ] Has the story been estimated?
**Definition of Done**
1. [ ] Passes developer unit tests
2. [ ] Passes peer code review
3. [ ] If there's a user interface, passes UX assurance
4. [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
5. [ ] Confirm Test cases built and succeeding
6. [ ] No regression test failures
7. [ ] Test coverage acceptable by Product Owner
8. [ ] Ticket ready to be merged to master or story branch
9. [ ] Developer to list Config changes/ Update documents and designs
10. [ ] Can be demoed in Sprint Review
11. [ ] Tagged as part of a Release
12. [ ] Feature flagged if required
13. [ ] Change Management activities done?
Contributor guide
Research direction
Start with the Contact Applicant view and the ComposeTemplate flow, then trace how the Select Template modal connects to the Add File section and the rich text editor. Review dependencies #104 and #353 and resolve the open scope questions before implementation. Done means the listed scenarios work, including selection, alphabetical listing, dates, navigation, attachment, and opening or closing a letter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 34/100