What Documentation Do I Write?
There is a tiny behind-the-scenes change that does not affect workflows (ex. small performance fix).
No doc.
Fix is not Staying Current, does not require build, and users do not need to be trained.
No doc!
Hyperspace used to crash and now it doesn't (and that's the only change).
No one-liner.
Fix timeline for ITF Nova QANs
Trainers must train users on your change (and is not an SU).
Release note, training slide, MAYBE a tip sheet (if there is a new workflow with multiple steps).
There is no existing guide content, there are no new options with the development, we are retiring a feature no one uses.
Doc! (Release note with a Galileo search). Any time we retire or remove a feature, this is the documentation required.
Foundation system changes
No one-liner. FS changes never use them.
Fix timelines for ITF galaxy QANs
Within one month of assignment
There is a bug in the system and we "fix" it by providing a way to update the system (ex. run a utility, change a setting, etc.).
Release note, in rare occasions a Galaxy update.
There is already an existing tech note.
9/10 times doc! In the rare instance where no additional documentation is required, then you should create a no doc record and attach the tech note (this should be approved by the Upgrade Specialist Group before doing so).
Reportable fix that would typically be a no doc.
No one-liner, this is already documented in Sherlock.
The point at which you may close a doc QAN as fixed
Analysts might use a new option or tool in their workflows.
A targeted notification and an update to the Admin Enhancement Directory.
There is FS development that we created an add-on Turbocharger for but do not expect live customers to take on their own.
No doc! Since this is for installing customers only and they will need TS assistance, we do not need to add this to the enhancement directory.
SUs
SUs no longer receive one-liners.
Your change is a Recommended If Foundation System update.
Release note with a training slide.
We are moving or automatically changing the way a piece of data is stored in Chronicles.
Doc! This is a Data ACEB. It requires a release note - there is a Wiki specifically for this situation.
Data Courier - the log is fixing an issue where we weren't logging a version skew error consistently.
One-liner.
The most clear-cut strategy to determine the impact of a change to a published release note - i.e., how many customers will actually see the edits if you make them
In Nova, the Statistics tab will tell you the percentage of customers who have already reviewed it (available for Required Reading and Staying Current notes). You must first open the note in the EMC2 view and then click on the open in Nova link to see the statistics tab.