WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
I suggest updating citations for the sources of direct quotations. It looks like most citations of this sort use a footnote. However, there is one exception, which uses a bracketed...
When the migration to a new repo is done, update the link in the Feedback section of the guide to point to the new repo: https://stylepedia.net/style/6.1/#feedback
There might be a plan for this already, but in case there’s not — the IBM Style Guide mentions and links to the Red Hat writing guide at stylepedia.net. After...
Hi there! :) I noticed that there isn’t a Contributing guide for this repository. It’d be helpful to add one so people can understand how to effectively contribute to it
I'm adding this here because we don't have an issue tracking system for the OPL (yet). https://docs.google.com/spreadsheets/d/1DLS_lS3VKidgZIvcLmLp9BoiqptkvqHWfe1D5FD2kfk/edit#gid=1375785039&range=C167 The description for Ansible Playbooks needs rewriting. SteveB has offered to provide the...
This table only has one row. Hardly seems worth having a table. Maybe introduce more examples or don't use a table?
To ensure that links continue to work over updates, we should create a symlink called "latest" that points to the latest version of the style guide.
https://stylepedia.net/style/6.0/#active-voice I suspect the entire subsection could do with a review, but this bit in particular needs a rework: For example, the sentence, "The Developer Center, a site for reference...
https://stylepedia.net/style/6.0/#overall-book-design If you read through the subsections here it's easy to find content that is outdated or unclear. I think this section was written before the guide went public, and...
https://stylepedia.net/style/6.0/#view-edit-files This is just one example. It uses DocBook to describe how to mark up content for effect. Need to instead focus on "highlight" (in this case) rather than saying...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.