https://github.com/suse/doc-styleguide

SUSE Documentation Style Guide
https://github.com/suse/doc-styleguide

docs opensuse styleguide suse writing

Last synced: 3 months ago
JSON representation

SUSE Documentation Style Guide

• Host: GitHub
• URL: https://github.com/suse/doc-styleguide
• Owner: SUSE
• License: other
• Created: 2015-06-23T08:44:23.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2025-09-03T09:10:24.000Z (9 months ago)
• Last Synced: 2025-09-03T10:25:41.102Z (9 months ago)
• Topics: docs, opensuse, styleguide, suse, writing
• Homepage: https://susedoc.github.io/doc-styleguide/main/html/style-guide/
• Size: 4.22 MB
• Stars: 14
• Watchers: 11
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= SUSE Documentation Style Guide

This style guide provides answers to common writing, style and layout questions

for SUSE documentation. The guide now offers two fully maintained 

versions: one for DocBook XML and one for AsciiDoc. While both guides address the 

same core questions about voice, terminology, structure and layout, each applies 

specific rules to its format.

Select your format and follow the conventions to make your content 

clearer for readers, easier for translators, and smoother for contributors.

The two versions of the Style Guide are published at 

https://documentation.suse.com/style/current/[doc.suse.com/style].

Contributing

-------------

We welcome contributions via pull requests. Use the `main` branch as the basis for

your feature branches.