https://redhat-documentation.github.io/supplementary-style-guide/

This project maintains the Red Hat supplementary style guide for product documentation that supplements the IBM Style guide
https://redhat-documentation.github.io/supplementary-style-guide/

hacktoberfest

Last synced: 6 days ago
JSON representation

This project maintains the Red Hat supplementary style guide for product documentation that supplements the IBM Style guide

• Host: GitHub
• URL: https://redhat-documentation.github.io/supplementary-style-guide/
• Owner: redhat-documentation
• License: cc-by-sa-4.0
• Created: 2019-11-20T11:20:55.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T14:35:57.000Z (2 months ago)
• Last Synced: 2024-08-27T16:07:48.691Z (2 months ago)
• Topics: hacktoberfest
• Homepage: https://redhat-documentation.github.io/supplementary-style-guide/
• Size: 2.46 MB
• Stars: 34
• Watchers: 13
• Forks: 73
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-technical-writing-learning - Red Hat Supplementary Style Guide for Product Documentation - Supplementary to the IBM Style Guide. It provides format examples in AsciiDoc. (Technical writing / Editorial style guides for technical writing)
• awesome-technical-communication - Red Hat supplementary style guide for product documentation

README

        
# Red Hat supplementary style guide for product documentation

## About

The purpose of this project is to create an official _Red Hat supplementary style guide for product documentation_, supplementing the _IBM Style_ guide, in direct support of cross-product solution documentation issues. The intended users are product documentation teams at Red Hat and upstream project contributors.

View the latest version of the guide: [Red Hat supplementary style guide for product documentation](https://redhat-documentation.github.io/supplementary-style-guide/)

## Suggestions or questions?

If you have a suggestion or question, open an [issue](https://github.com/redhat-documentation/doc-style/issues) in this project.

## Contributing

See the [Contributing guide](CONTRIBUTING.md) for information about how to contribute an update.

## What's new

See the [history of significant updates](HISTORY.md) to the _Red Hat supplementary style guide for product documentation_.

## Administrator responsibilities

See the list of [administrator responsibilities](ADMIN.adoc) for more information on what to do in your role as the administrator of this repository.  

## Building the guide locally

You can build the guide locally using [Asciidoctor](https://asciidoctor.org/).

```

$ cd supplementary_style_guide

$ asciidoctor main.adoc

```

Open the generated `main.html` file in a browser to view the built guide.

## License

This work is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).