Create Acknowledgement Letter
- Dominant language
- Python
- Stars
- 8
- Forks
- 2
- Avg merge
- 14h 34m
- Merged PRs (30d)
- 46
Description
* As an analyst
* I want to generate templated Acknowledgement letters
* so that I can send consistent correspondence to the applicant with minimal manual effort
**Assumptions & Scope**
Applicant has a valid email address
What is in and not in scope?
In scope: document generator
Not in scope: editing, selecting where to redirect to, sending correspondence
**Acceptance Criteria**
**Scenario 1: Generate Acknowledgement Letter**
* GIVEN an analyst has Opened the request
* WHEN the analyst clicks Create Redirect Letter
* THEN the analyst is taken to the Correspondence page: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
*AND the 'To' field is auto-filled with the applicant's email, the 'From' field is auto-filled with the analyst's email, the 'Subject' field is auto-filled with the Request ID, and the 'Email Description' is auto-filled with "Please see the attached regarding your FOI request"
*AND the generated letter is available as a link named "Redirect Letter - Request ID"
**Scenario 2: View Redirect Letter**
* GIVEN an analyst has generated the Redirect letter
* WHEN the analyst clicks on the letter link "Redirect Letter - Request ID"
* THEN the letter view is brought up: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
* AND the analyst can scroll to view the full letter
* AND the letter contains the templated wording and formatting *TBD*
**Scenario 3: Exit View Redirect Letter**
* GIVEN the analyst is viewing the Redirect letter: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
* WHEN the analyst clicks on the X in the top right corner or the Return to Correspondence button
* THEN the letter view is closed
* AND the analyst is brought back to the Correspondence page: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play
*
**Dependencies? What is the impact of this dependency? (If so, link dependency in the ticket, make it visible in a team´s backlog)**
**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 Correspondence page and the linked InVision prototype referenced in the scenarios. Resolve the missing design, template wording, dependencies, and the acknowledgement-versus-redirect terminology before implementation; done should cover the three listed scenarios and their acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100