I’d like to start writing high level description of various features of the CMS. The primary audience for these are CMS editors, and they should be written so that they are largely evergreen, and reusable in several places:
User-facing product release notes
Training sessions
Documentation
A CMS “feature list” (for product owners and VFS teams curious about what the CMS can do)
I’d like to start writing these before we start work on new features / products, including during CMS scoping exercises, and within epic and enhancement issue templates. As a general structure:
One sentence describing value to end users (keep the focus on vets)
Description of the overall editorial experience that supports that value, and other benefits to the business
Some details about the functionality
Ideally are limited to about 750 characters.
Here’s an example for this week’s training and documentation and the rollout of the VAMC operating status.
@andrewlewandowski do you have any feedback about this feature description for banner alerts
@JeffBarnesUSDS thoughts about the overall purpose and structure of these feature descriptions?
/cc @jefflbrauer @howardbrande
Example feature description
VAMC banner alerts and facility operating status
Veterans and VA employees need up-to-date information about the operating status of VHA facilities.
Whether it’s inclement weather or road closures, the VA.gov content management system allows VAMC editors to update facility operating status and add banner alerts and situation updates to VAMC pages, all in one streamlined editorial experience.
Editors of VAMC banner alerts can optionally trigger email bulletins via each VAMC system’s emergency updates email list, either when creating the initial alert, or with additional situation updates that editors add as new information becomes available.
For situations affecting multiple VAMCs, such as a hurricane, VISN or VHA editors can create one banner alert to display across a region.
Goal
Better training, product releases, documentation.
Acceptance Criteria
We have a VAMC banner feature description for training and documentation this week
We have a template for writing new feature descriptions.
kevwalsh
commented
4 years ago
Description
I’d like to start writing high level description of various features of the CMS. The primary audience for these are CMS editors, and they should be written so that they are largely evergreen, and reusable in several places:
I’d like to start writing these before we start work on new features / products, including during CMS scoping exercises, and within epic and enhancement issue templates. As a general structure:
Ideally are limited to about 750 characters.
Here’s an example for this week’s training and documentation and the rollout of the VAMC operating status.
@andrewlewandowski do you have any feedback about this feature description for banner alerts @JeffBarnesUSDS thoughts about the overall purpose and structure of these feature descriptions?
/cc @jefflbrauer @howardbrande
Example feature description
VAMC banner alerts and facility operating status
Veterans and VA employees need up-to-date information about the operating status of VHA facilities.
Whether it’s inclement weather or road closures, the VA.gov content management system allows VAMC editors to update facility operating status and add banner alerts and situation updates to VAMC pages, all in one streamlined editorial experience.
Editors of VAMC banner alerts can optionally trigger email bulletins via each VAMC system’s emergency updates email list, either when creating the initial alert, or with additional situation updates that editors add as new information becomes available.
For situations affecting multiple VAMCs, such as a hurricane, VISN or VHA editors can create one banner alert to display across a region.
Goal
Better training, product releases, documentation.
Acceptance Criteria