# Rh Ssg Release Notes

> Review Red Hat release notes for SSG compliance — tense rules (present default, past for before this update), informative headings (sentence case, no gerunds, under 120 chars), Jira references on known/fixed issues, AsciiDoc formatting (description lists, + attachment), and release note types such as new features, enhancements, rebases (X.Y.Z format), Technology Preview entries, deprecated featur…

- **Type:** Skill
- **Install:** `agentstack add skill-opendatahub-io-docs-skills-rh-ssg-release-notes`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [opendatahub-io](https://agentstack.voostack.com/s/opendatahub-io)
- **Installs:** 0
- **Category:** [Productivity](https://agentstack.voostack.com/c/productivity)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [opendatahub-io](https://github.com/opendatahub-io)
- **Source:** https://github.com/opendatahub-io/docs-skills/tree/main/skills/rh-ssg-release-notes

## Install

```sh
agentstack add skill-opendatahub-io-docs-skills-rh-ssg-release-notes
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Red Hat SSG: Release Notes review skill

Review release notes for compliance with the Red Hat Supplementary Style Guide.

## Checklist

### General style

- [ ] Focus on impact to the user; omit overly technical details
- [ ] Avoid passive voice, modal verbs, and ambiguous language ("Should XY happen" > "If XY happens")
- [ ] No infinitive statements from changelogs ("Remove deprecated macros" > "Deprecated macros are removed")
- [ ] Unfamiliar terms (utilities, packages, commands) are defined on first mention outside headings
- [ ] Abbreviations are expanded in descriptions (not in headings)
- [ ] Sentences do not start with a lowercase word — repeat the definition if needed
- [ ] Admonitions are minimal; release notes do not begin with admonitions

### Tenses

- [ ] Simple present tense is the default
- [ ] No future tenses, "should," or "might" for post-update state
- [ ] Simple past tense describes the situation before the current update
- [ ] "Now" is not used to refer to the post-update state
- [ ] Fixed issues follow CCFR tense logic (Cause-Consequence-Fix-Result)
- [ ] "Before this update" is used instead of "previously"

### Headings

- [ ] Each release note has an informative heading summarizing the note
- [ ] Headings use sentence-style capitalization (not title case)
- [ ] Headings are under 120 characters
- [ ] Headings do not start with a gerund (release note headings should be descriptive, not task-oriented)
- [ ] Headings mention the component when it might not be obvious
- [ ] Headings are specific, not overly generic ("Program no longer crashes" is too vague)
- [ ] Abbreviations in headings are not expanded (expanded in the text below)

### Jira references

- [ ] All Known issues and Fixed issues include Jira ticket references
- [ ] Jira references are on the line directly after the entry (not in parentheses or brackets)
- [ ] If tickets require login, introductory text states: "Some linked Jira tickets are accessible only with Red Hat credentials."

### AsciiDoc formatting

- [ ] Each release note is a description list item (not nested headings)
- [ ] Additional paragraphs after the first line are attached with `+` on a separate line
- [ ] Lists within a release note are attached with `+`, and a `+` follows the list before the next paragraph
- [ ] Open blocks (`--`) are attached with `+` before and after

### New features and enhancements

- [ ] Describes **what** the feature/enhancement is, **why** it benefits the customer, and the **result**
- [ ] Links to product documentation if available
- [ ] When TP becomes fully supported, this is clearly stated

### Rebases

- [ ] Version uses X.Y.Z format only (not `+1-A.elN`)
- [ ] Includes a parallel list of highlights
- [ ] No blank rebase descriptions — include details if the component is important
- [ ] Zeroth minor versions (e.g., 10.0): "provided in version X.Y.Z" not "rebased to"

### Technology Preview features

- [ ] Heading ends with "(Technology Preview)"
- [ ] Description mentions the feature is a Technology Preview
- [ ] Technology Preview admonition is NOT used in release notes (would be repetitive)
- [ ] TP release notes are repeated in subsequent releases until GA or removal

### Deprecated features

- [ ] Describes the feature, states it is deprecated, and provides the alternative
- [ ] Does not use "Recommended" — per SSG glossary
- [ ] Does not repeat the definition of "deprecated" from the section intro
- [ ] Does not predict future feature statuses: "will be deprecated next release"

### Removed features

- [ ] Feature was documented as deprecated in a preceding release
- [ ] Describes the feature, states it is removed, and provides the alternative
- [ ] Small part removals are treated as feature changes, not removed features

### Known issues

- [ ] Follows: Cause > Consequence > Workaround > Result structure
- [ ] Workaround is in a separate paragraph: "To work around this problem, ..."
- [ ] If no workaround exists: "No known workaround exists."
- [ ] Uses present tense
- [ ] Never promises future fixes

### Fixed issues (bug fixes)

- [ ] Follows CCFR: "Before this update, . As a consequence, . With this release, . As a result, ."
- [ ] Cause and consequence in past tense; fix and result in present tense
- [ ] Uses "before this update" not "previously"

## How to use

1. Review only changed content and necessary context
2. For each issue found, cite the relevant SSG section and release note type
3. Mark issues as **required** (wrong tense, missing Jira reference, missing heading) or **[SUGGESTION]** (style improvements)

## Example invocations

- "Review these release notes for SSG compliance"
- "Check the known issues section in release-notes.adoc"
- "Do an SSG release notes review on the 4.17 release notes"

## References

For detailed guidance, consult:
- [Red Hat Supplementary Style Guide: Release notes](https://redhat-documentation.github.io/supplementary-style-guide/#release-notes)

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [opendatahub-io](https://github.com/opendatahub-io)
- **Source:** [opendatahub-io/docs-skills](https://github.com/opendatahub-io/docs-skills)
- **License:** Apache-2.0

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-opendatahub-io-docs-skills-rh-ssg-release-notes
- Seller: https://agentstack.voostack.com/s/opendatahub-io
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.
