-
Notifications
You must be signed in to change notification settings - Fork 74
Add general style guidance based on the Release Note Improvement Initiative, Working Group 1 #524
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add general style guidance based on the Release Note Improvement Initiative, Working Group 1 #524
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: jafiala <[email protected]>
Co-authored-by: jafiala <[email protected]>
Co-authored-by: jafiala <[email protected]>
Co-authored-by: jafiala <[email protected]>
Co-authored-by: Brian Angelica <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove IBM Style links
remove IBM Style links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aligning terminology
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay, I've added some feedback.
In addition to this, I was wondering whether there was any further guidance coming on writing release notes. A few things that came to mind are recommending to link to existing doc content for more information on a feature, etc. Or recommendations on how much detail to go into in the release note - I assume we prefer to be concise (sometimes cut out excessive technical detail), but maybe that's just my personal preference.
Also, we mention several categories, but do have any preferred order or actual names that we want each category to be named, so that teams are doing so across products?
Thank you Andrea, I will go through your suggestions! We have additional guidance in progress specifically on RN types and the chapters they are in, as well as a template for a RN document (which should be useful mainly for new products). Recommendation to link to existing product docs is part of the new feature/enhancement type. I think some additional guidance on being concise and cutting overly technical details is also a good idea, I'll add it into the general points. |
In the rewrite, you need a comma between "past" and "and" in the second sentence. You are joining 2 independent clauses. Co-authored-by: Andrea Hoffer <[email protected]>
Andrea's review easy fixes Co-authored-by: Andrea Hoffer <[email protected]>
Remove asciidoc syntax
Issue:
The current guidance for writing release notes was insufficient; we propose expanding this section with general guidance that should address commonly encountered problems in RN texts.
Additional information:
Draft prepared by Ingrid Towey, Darragh Fitzmaurice, James Smith, Brian Angelica, Jan Fiala