bcgov / MFIN-Data-Catalogue

The Finance Data Catalogue enables users to discover data holdings at the BC Ministry of Finance and offers information and functionality that benefits consumers of data for business purposes. The product is built using Drupal and adheres to the Government of BC's Core Administrative and Descriptive etadata Standard.
Other
6 stars 0 forks source link

Sprint 18 project review #490

Closed CraigClark closed 5 months ago

CraigClark commented 5 months ago

OP timer

https://openplus.monday.com/boards/4092908516/pulses/6731264863


MFIN BC Data Catalogue Overview

History

Talk about:

Project Recap

Phase 1 | Inception Phase

February 9 to May 31, 2023

  1. UX report | Documentation review, user interviews, co-creation workshop findings, and recommendations
  2. Product roadmap | Identify the vision and priorities of the product for each phase of the project.
  3. Service design blueprint | Write a detailed plan of how the service will be delivered, start to finish.
  4. Develop content architecture
  5. Initial software deployment to BC cloud infrastructure

Collaboration

Phase 2 | Proof of Concept Phase

June 1 to December 31, 2023

  1. Mockups/design files based on findings of phase 1
  2. Deploy working software to be tested against user stories
  3. Write automated test scripts - From this point on, tests are run for every feature
  4. Development and deployment of base-build for use across multiple Drupal projects.
  5. Deploy working data catalogue to BC cloud architecture

Collaboration

Phase 3 | Implementation Phase

January 1 to May 21, 2024

Collaboration

Application Walkthrough

Part 1 | IDIR User

  1. Point out new theme and explain
  2. Log in with IDIR | This shows SSO
  3. Resize screen so people can see labels are icons on mobile
  4. Point out how the footer reflects org | Personalization
  5. Show Documentation page | Best to show docs on prod if possible - Note that there are docs for users, editors and DC Admin with docs for developers in the repo
  6. On Documentation page, click 'Printer friendly version' | This can be used to generate an ePub or PDF of the docs
  7. Click 'Working with metadata records' | Shows what a doc page looks like with nav
  8. Show the Documentation search | may not have many results unless you are on prod
  9. Go to search page
  10. Resize screen so people can see collapsed blocks on mobile
  11. Demonstrate facets by selecting a few
  12. Clear the facets
  13. Do a search for 'taxation'
  14. Use the save search box to save the search
  15. Check the box beside 4 or 5 items in the search results
  16. Click the bar that says 'Selected * items' to show that it tells you what items you have selected
  17. Generate an .xlsx file from the results
  18. Show the file in Excel after it downloads
  19. Go back to the catalogue in the search results and select a record to show | I tested with this test record on dev. A record with lineage and a data dictionary would be ideal
  20. on the record | Explain record visibility
  21. on the record, Bookmark the record | Note that it shows how many others bookmarked it
  22. on the record, explain that there are tags that will show for Needs review, Review overdue, Personal information and High value depending on the values of the record. Explain that visibility will have a green indicator for public, amber for IDIR users and red if it's org specific
  23. on the record, go through each field and explain anything that isn't obvious | show the lineage, explain field visibility, this applies to record visibility, location and related documents
  24. click a link with a search icon | Show that this is a pre-filtered search
  25. use the browser back button to get back to the record
  26. Click the information schedule link | Explain what this is, why it's important
  27. Back to record
  28. Show the data dictionary
  29. Expand all items in the data dictionary
  30. Explain that the data dictionary can be downloaded |No need to demo, we saw it with search
  31. In the browser, select print | There was a request for printable records, just show the print preview, we want people to see that extraneous info and UI elements are removed on print
  32. Go to the revisions tab | a quick explanation of revisions and how to compare should do here
  33. Explain what a permalink is
  34. Click on 'Dashboard' in the header
  35. Show where the bookmark has been saved | This will show the 10 most recent bookmarks with a link to the bookmark page where all bookmarks are
  36. Show the saved searches | This will show the 10 most recent saved searches with a link to the saved searches page where all saved searches are
  37. Click the reports tab
  38. Explain what the 'Metadata metrics' report is
  39. Click the dependency reports tab
  40. Explain what the dependency report is
  41. Click the report builder tab
  42. Explain what the reports builder is and what it does | show side bar sliders and point out that these can be downloaded to CSV

Conclude IDIR User demo


Part 2 | Editor

Logged in with an account that has the editor role

Explain how the permissions work here | You can create/edit in org you belong to

  1. go to the dashboard
  2. do a dashboard walkthrough explaining the different sections | note that there is a management tab not available to IDIR users
  3. Click the 'Manage' tab, explain what this page does | Note that buttons in the action column will be different depending on what the user has permission to do
  4. Go back to the dashboard
  5. Create a new test record of type data | If your user has more than 1 org, explain that most editors won't see the org drop-down
  6. Create a new test record of type report
  7. Click build beside the data record, go back to dashboard and select build beside the report | *Explain that the sections and fields people see depends on what type of asset they are describing**
  8. Click build beside the data record
  9. Open each build section and fill out the form | As you go, explain what each field does, point out things like field help text, how things relate to each other, why we chose the form input we did
  10. Save each section as you go
  11. Go back to the build page | Point out here that the summaries are designed to show a field has content while saving space
  12. Explain the revision note
  13. Note that there is no 'Last review date'
  14. Select major update and full review
  15. Explain the edit type and Full review | just the characteristics, the functionality of notifications comes later
  16. Publish
  17. Click the build tab | We want to show how to do an update
  18. Note that there is a checkbox for full review with no other options, explain that
  19. Note the Dates and explain | Last review date is the last time the review box was checked, Next review date is the last time full review was checked plus the update interval, Record modified will update every time the record is published with Major update checked. If it's a major update, and the date is greater than the published date, a record modified date appears on the record view
  20. Make a change
  21. Publish
  22. Go to revisions tab | *show that editors have a button to revert a revision - no need to do it**
  23. Go to the data catalogue home page

Explain the Notifications System

Special Cases

It wasn't shown, there is a report available to information managers that other people do not see

Base-build

Say a few words on what it is, why it's good and that it's being used on other projects

Technical Info

Misc

Note that this project has resulted in fixes and enhancements that have been contributed back to the Drupal community.

Thank-you's

We want to draw attention to this being a team effort.

NicoledeGreef commented 5 months ago

I want to mention that we had our first ticket come in through the Jira Service Management queue: it was a request to change OPR on multiple records in Prod. Also, I want to ensure I thank everyone for participating in the Think Aloud sessions and leave time for Acknowledgements.