BCMS Features Scoping Plan
(Updated 28 June with the outcomes of the scoping sessions)
Context
The BCMS has a high number of features and design improvement requests that cut across the entire application. In order to understand the path forward and ensure that development effort is not wasted, the NCBI and Coko teams will conduct a series of focused scoping sessions.
Meeting format
A three-hour time slot will be set aside for each session. Stacy, Dione and Christina will be present for all sessions and will include NCBI and Coko team members as needed. To ensure progress in the sessions is not held back we ask that the following team members are available to respond to any questions that may come up in Coko/NCBI mattermost chat OR NCBI SLACK and join the call if necessary:
- Giannis (BCMS lead developer, Coko)
- Danjela (BCMS frontend developer, Coko)
- Evgeny (BCMS Technical Lead, NCBI)
- Martin (Technical specialist in XML Conversions group, NCBI)
- Denis (NCBI Developer managing BCMS migration, NCBI)
- Diana (Content specialist, NCBI)
- Susan (Content specialist, NCBI)
- Erin (Product manager, NCBI)
Scoping focus and schedule
Overview
See the agenda below.
Excluding the scoping done for Book versions and the issues defined in "Deployment 1 milestone", there are ~35 issues considered as features and design improvements that NCBI has marked for inclusion in Deployment 1. There are an additional ~29 bugs that require review against these features and design improvements to ensure that they are all still relevant and accurate.
We suggest the following process:
- Prior to the first scoping session Coko team reviews issues to ensure that they are linked to the correct epic. (done)
- Coko team triages the issues into a logical scoping order and provides an agenda for the sessions for Stacy's review. (done)
- Coko team prepares Miro board for visual collaboration (in progress)
- Stacy reviews the agenda provided here and we discuss any feedback to sign-off (We request feedback by Monday)
Detailed agenda
Download agenda updated 25 May: BCMS_Scoping_agenda-20220525-v2.pdf
See updated agenda below:
BCMS Scoping Agenda
Session 1: Wednesday 18 May 09:30–10:30 EST Focus: Status, error and key information reporting on main UIs | ||
Agenda detail |
Relevant issues |
Notes |
Validate current and desired behaviour on main UIs in relation to statuses and error reporting |
#1156 (closed) and related issues specified there |
Update post-session: We need to come back to this after Session 3 to make decisions on status for chapter-processed books and collections |
Resolve blocked issues for generated TOCs in relation to status of members |
Update post-session: still blocked due to indecision on status[a][b] |
|
Validate workflow of user-supplied TOCs in relation to statuses and errors |
Update post-session: we ran out of time to cover this. Reschedule required |
|
Resolve blocked issue for Dashboard permissions |
Update post-session: Resolved |
|
10:30–11:30 EST Focus: Automated checks and information reporting for the publish step | ||
Agenda detail |
Relevant issues |
Notes |
Pre-release automated checks |
Only some of the release checks have been discussed in detail. This session is therefore required.
Update post-session:
|
|
Validate if “Agreements API check for PDF display settings” is still relevant and required |
This is not on the Deploy 1 list however we’d like to clear up all remaining issues related to publishing.
Update post-session: We confirmed that this is not part of the scope for Deployment 1 |
|
NCBI’s feedback from testing on their deployment with real domains |
#481 (closed) (see latest comment) and #1183 (closed) |
NCBI to demo the issue with Denis and Giannis present
Update post-session:
|
11:30–12:30 EST Focus: Wholebook PDF build and use cases for deleting content | ||
Agenda detail |
Relevant issues |
Notes |
Providing chapter files with generated TOCs for wholebook PDF build |
Update post-session: Postponed to later session |
|
Delete feature use case for:
|
Original issue with all delete cases - #118 (closed)
Update post-session: The workflow for duplicate was agreed. The remainder of this discussion is postponed to an extension of Session 3
|
Session 2: Thursday 19 May 09:30–12:30 EST Focus: all remaining development for the Errors management epic (&12) Note: There is a lot to cover here so it may flow into Session 3. If so, we may need to add another scoping session
| ||
Agenda detail |
Relevant issues |
Notes |
A high-level review of the BCMS content errors streams: submissions, conversion, loading, releasing/publishing |
Covered in full |
|
Confirm FTP submission errors spec |
See issues in Epic &49 (closed), full spec in #438 (closed) |
This was blocked by Book version scoping, now concluded. Coko will update issue prior to this session
Update post-session:
|
Accepted submission file types per workflow |
#986 (closed) and the blocked issues linked
|
Update post-session: Spec confirmed and issue updated – assigned to Stacy to sign off
|
Validate spec of remaining issues relating to:
|
See issues in sub-epics &50 (closed), &51 (closed), &53 (closed) |
Update post-session:
|
Review all issues related to reporting errors in the against decisions made in Session 1 |
See issues in the Report errors sub-epic (&52 (closed)) |
The outcomes of this should be a consolidated updated spec for reporting errors.
Update post-session:
|
Session 3: Wednesday 25 May 07:30–08:30 EST Focus: NCBI's customers use cases for 'Book type' | ||
Agenda detail |
Relevant issues |
Notes |
Monographs |
From Stacy: I will map out an ideal target so you can see where we want to go and what we minimally need to get there – provided by Stacy here.
|
|
One Doc |
see issues linked to original feature in #215 (closed) |
From Stacy: this is related to funded content |
08:30–10:30 EST Focus: Finalising Settings and Metadata epics | ||
Blocked issues related to settings |
From Stacy: this is related to funded content - i will map out an ideal target so you can see where we want to go and what we minimally need to get there |
|
Blocked issues related to metadata, in particular grants and covers |
See open issue in Epic &9 With ‘prod deploy 1’ and ‘fix before prod deploy 1’ labels |
From Stacy: this is related to funded content - i will map out an ideal target so you can see where we want to go and what we minimally need to get there |
Session 3 extension 13:00–14:00 EST Focus: Items postponed from previous sessions | ||
Agenda detail |
Relevant issues |
Notes |
|
See update: https://gitlab.coko.foundation/ncbi/ncbi/-/issues/1220#note_89307 |
These items came up in Sessions 1 and 2. We need to understand what’s possible on NCBI-side to progress with the suggested integration improvements. |
Delete feature use case for:
|
In addition to validating the workflow we require detail on the technical integration for both ‘user mistake’ and ‘duplicate’ uses cases |
Session 4: Thursday 25 May 07:00–09:00 EST Focus: Items postponed from previous sessions | ||
Agenda detail |
Relevant issues |
Notes |
Outcome from Session 3 extension:
|
|
Allow 1 hour. |
Postponed items from Session 1 09:30–10:30 EST: Validate workflow of user-supplied TOCs in relation to statuses and errors |
Allow 1 hour. Session above must be completed (or covered within the same session) |
|
Review of remaining Deployment 1 issues to assess whether any further sessions are needed. |
All issues labelled “prod deploy 1” and “fix before prod 1” not already covered in previous sessions |
Allow 1 hour and complete any remaining grooming async. |
Session 5: Friday 27 May 08:00–09:00 EST Focus: Items postponed from previous sessions | ||
Agenda detail |
Relevant issues |
Notes |
Postponed item from Session 1 1:30–12:30 EST: Providing chapter files with generated TOCs for wholebook PDF build |
Allow half an hour. Martin present |
|
Parts with content |
Allow half an hour. Martin present |
[a]you mean the integration point of communicating the PMCBook domain property of QA or Live status so it can be displayed in the BCMS?
[b]Yes
Outcomes from these scoping sessions
NCBI and Coko teams will aim to complete these outcomes within a week after session 5.
- Coko and NCBI task: Updated specifications, where necessary, which will be reviewed by the entire team and signed-off before development begins. -- in progress
- Coko task: Updated Deployment 1 development estimates -- all estimates are recorded in the BCMS scoping list
- NCBI task: Clear communication of the priority levels for all the issues that NCBI has marked for inclusion in Deployment 1 and decisions on any issues that could be removed from priority list (if any). -- See column C in the BCMS scoping list
- Coko task: Updated Figma designs (the wireframes used be Coko to implemented frontend) -- this was not required for any of the items chosen for MVP deployment
- NCBI task: updated workflow diagrams (note: these are not required by Coko team)
- NCBI and Coko task: Updated Epic documentation to match decision made in scoping