bcgov / foi-flow

Freedom of Information modernization
Apache License 2.0
5 stars 3 forks source link

Redaction App Comments and Annotations - Filter/Select to Include in Redline #4862

Open KyEggleston opened 9 months ago

KyEggleston commented 9 months ago

Assumptions & Scope What are the assumptions for this story?

This is meant to replace #4799, as to be more 'future-proof', and allow more flexibility.

The Redaction App has a feature to select / filter comments and annotations by colour, type, etc.

image

Some processing teams have an established practice of including comments/annotations on redlines to explain decisions to Ministry reviewers. While we eventually want to be able to have Ministry reviewers access the application directly, that may be too far off to be acceptable given some teams existing practices with their clients.

We'd like to explore the idea of including comments and annotations in the redline, based on what has been filtered in the Comments pane. That is to say, any comment or annotation that shows up in the Comments pane, based on your filter criteria, will show up in the Redline.

Redactions should be included regardless of the filter criteria applied, That is to say, redactions should always appear in the redline, regardless of the filter criteria.

For example, if I filter the Comments pane to only show annotations/comments in green, and I produce the redline, only the annotations and comments associated with the green annotations will be displayed on the redline., including all redactions that have been applied (but not the comments associated with these redactions).

image

What is IN scope?

What is NOT in scope?

Acceptance Criteria

Scenario 1: Redline - Always Include Redactions

Scenario 2: Redline - Include Filtered Comments/Annotations

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?
KyEggleston commented 9 months ago

May cover this in our session with Redaction App pilot users on Thursday to discuss ideal state/options.

Need to determine how we want to handle redactions with comments. Do we always include the comments associated with redactions in the redline? Option to pick and choose? How would we do this.

@lmullane @liseandtea @JHarrietha-AOT

lmullane commented 9 months ago

Decision is to have a different story for comment that are replies to redactions if needed.

KyEggleston commented 9 months ago

From the pilot user redaction app session:

cc: @liseandtea @lmullane

lmullane commented 9 months ago

Thanks for the update, @KyEggleston

aparna-aot commented 8 months ago

During the 01-10-2024 stand-up, we discussed with the business team the option of displaying Notes-type annotations by eliminating Redline PDF flattening. But the outcome of removing flattening is that redlines can be deleted (using delete keys) & the section numbers can be moved from their actual positions. So business prefers removing flattening only if we can restrict redline box movement.

Additionally, during standup we overlooked another outcome of removing flattening : Redline Package - Full Page Redline Visibility in Adobe and Browser #4450. This should be discussed in tomorrow's stand-up. cc.:@divyav-aot