Update Titles and headings section with expanded guidance#587
Merged
IngridT1 merged 2 commits intoApr 15, 2026
Conversation
Expand the "Titles and headings" section to provide more comprehensive guidance for writing effective titles and headings in Red Hat documentation. The update includes: - Detailed guidelines for different content types (procedures, concepts, references, assemblies) - Best practices for using imperative verbs vs gerunds - Guidance on heading length and scannability - Clear examples showing incorrect and correct approaches for each content type - Note about Jobs to Be Done format conversion This enhancement helps documentation teams create more user-focused, scannable, and SEO-friendly titles and headings. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
LGTM! The new examples are very helpful. |
sbmetz
previously approved these changes
Apr 15, 2026
IngridT1
commented
Apr 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expand the "Titles and headings" section to provide more comprehensive guidance for writing effective titles and headings in Red Hat documentation. The update includes:
This enhancement helps documentation teams create more user-focused, scannable, and SEO-friendly titles and headings.
Issue:
Additional information: