bcgov / bcgov/foi-flow

Summary of Redactions - Redline

Open
#4,975 2 comments 0 reactions 0 assignees View on GitHub
incomplete AC Story
Dominant language
Python
Stars
8
Forks
2
Avg merge
14h 34m
Merged PRs (30d)
46

Description

* As a Ministry executive
* I want a summary document of redactions applied
* so that I can better focus my review of records for sign-off

**Assumptions & Scope**
This story comes out of user feedback around having easier tools for Ministry approvers to review packages more quickly. Being able to identify more quickly pages that are being withheld vs disclosed can be helpful to focus the sign-off approvers time in reviewing a large package of records.

This will be included alongside the redline, as a standalone PDF

What is IN scope?
A summary document of redactions to be included when a redline is created

What is NOT in scope?
Summary document of redactions for a response package (story # )
Ad-Hoc summary document of redactions (story # )

**Acceptance Criteria**

**Scenario 1: Create Redline - Summary Document**
* GIVEN an IAO user has completed the review of records in the redaction app
* WHEN they activate the 'Create Redline PDF'
* THEN the redline will be created
* AND a summary of redactions will also be produced (see design: XXXX)

**Scenario 2: Download Redline for Ministry Sign-Off**
* GIVEN a user is on the records tab and has the download drop down activated
* WHEN they click on 'Download Redline for Sign-Off'
* THEN the redline package will automatically be downloaded as configured by the specific Ministry
* AND a summary of redactions will also be available as a single PDF

**Scenario 3: xxxxxx**
...

**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

Open the contributing guide

Research direction

No files, tests, or entry points are named in the issue. Start by clarifying the missing design, the incomplete acceptance scenarios, and how the existing Create Redline PDF and Download Redline for Sign-Off flows work. Done means a standalone redaction-summary PDF is produced with the redline, made available for download, and verified against complete acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.