| Excerpt |
|---|
|
A manual with a set of standards and best practices for the writing, formatting and design of documents. |
...
| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 6 |
|---|
| outline | false |
|---|
| type | flat |
|---|
| separator | pipe |
|---|
| printable | false |
|---|
|
Overview
A manual with a set of standards and best practices for the writing, formatting and design of documents.
...
A style guide establishes standard style requirements to improve the message and communication across an organisation by ensuring consistency both within an article, and across multiple articles.
Because practices vary, a style guide helps to set out standards to be used in areas such as writing style, page structure, formatting, certain procedures and other areas. The style guide may require certain best practices in usage, language composition and visual composition.
This template has examples that you could use to start writing a documentation style guide.
How to use the Style guide template
Step 1 - Provide an overview
Write a brief overview of the style guide you're creating and describe your target audience in the Text Data macro.
Step 2 - Define the goal
In short sentences, describe your goal of creating the style guide and how it may align with the purpose in the Text Data macro.
Step 3 - Add notes
Include relevant notes that people should be aware of when referring to the guide.
Step 4 - Define writing style
List down writing styles that are important to note in the Repeating Data macro
For example, using language that’s easy for everyone to understand.
Step 5 - Define the formatting
Outline the formatting that should be followed in the Repeating Data macro.
For example, capitalization, emboldening, code snippet.
Step 6 - Define page structure
Set the standards of page structure to use in the Repeating Data macro.
Step 7 - Define procedures
Detail out the procedures that people has to follow through in the Repeating Data macro.
Ingredients
Code
| Expand |
|---|
| title | Expand to use this template in your instance using storage format. |
|---|
|
You can copy and paste this code into the Confluence Source Editor: | Code Block |
|---|
<ac:layout>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<h1>Overview</h1>
<ac:structured-macro ac:macro-id="deaae2b7-0cfb-4bc5-be95-987f7617a4d4" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">Overview</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>Give a brief overview of the guideline you're creating and describe your target audience in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/text-data">Text Data</a> macro.</em>
</span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="3ccb66df-f191-48cc-8051-e423c425e27b" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">Overview</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<h1>
<span style="color: rgb(0,51,102);font-size: 24.0px;letter-spacing: -0.01em;">Goal</span>
</h1>
<ac:structured-macro ac:macro-id="0717d2a5-3c73-448f-aa01-6d1ee8d6e744" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">Goal</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<em>
<span style="color: rgb(165,173,186);">Describe the goal of the guideline in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/text-data">Text Data</a> macro</span>
<span style="color: rgb(165,173,186);">.</span> <br/>
</em>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="fd21aa74-91db-44d1-bd05-296bb985a416" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">Goal</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<p>
<em> <span style="color: rgb(23,43,77);"> <br/>
</span> </em>
</p>
</ac:layout-cell>
<ac:layout-cell>
<ac:structured-macro ac:macro-id="e6130ed0-3486-4947-96a0-c2d46526ce1c" ac:name="info" ac:schema-version="1">
<ac:parameter ac:name="title">Can't find what you need?</ac:parameter>
<ac:rich-text-body>
<p>Send us an e-mail at <a href="mailto:apps.support@servicerocket.com">apps.support@servicerocket.com</a> for assistance.</p>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="single">
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<ac:structured-macro ac:macro-id="8faade0f-64c5-44ff-a8de-3db7d5c07d64" ac:name="panel" ac:schema-version="1">
<ac:parameter ac:name="borderColor">#AED6F1</ac:parameter>
<ac:parameter ac:name="borderWidth">1</ac:parameter>
<ac:parameter ac:name="titleBGColor">#AED6F1</ac:parameter>
<ac:parameter ac:name="title">Notes</ac:parameter>
<ac:rich-text-body>
<ac:structured-macro ac:macro-id="51d829f4-a567-4944-955a-6d104afa9460" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">Notes</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>Add relevant notes that writers should be aware of in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/text-data">Text Data</a> macro.</em> </span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="da0d807c-5859-4e40-8b69-b432f5b48fb1" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">Notes</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<h1 class="_2cuy _509y _2vxa" style="text-align: left;">
<span style="color: rgb(0,51,102);">Writing Style</span>
</h1>
<ac:structured-macro ac:macro-id="f24acdcd-87ac-47f7-add5-b803024cf6d7" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">WritingStyles</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>List writing styles that writers should follow in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/repeating-data">Repeating Data</a> macro.</em> </span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="651ed4ca-5092-4632-9d61-462bee8af20f" ac:name="repeating-data" ac:schema-version="1">
<ac:parameter ac:name="name">WritingStyles</ac:parameter>
<ac:parameter ac:name="initialRows">3</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
<ul>
<li class="auto-cursor-target">
<ac:structured-macro ac:macro-id="4d22ff29-e188-4ed4-acc2-736558fe7a54" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">WritingStyle</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
</li>
</ul>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="single">
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<h1 class="_2cuy _509y _2vxa" style="text-align: left;">
<span style="color: rgb(0,51,102);">Formatting</span>
</h1>
<ac:structured-macro ac:macro-id="01b25c29-7b6e-4d0b-8273-1daa1fa5b0f0" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">Formattings</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>List formatting types that writers should follow in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/repeating-data">Repeating Data</a> macro.</em> </span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="5c497860-d52f-4579-a9b0-17f608a451a7" ac:name="repeating-data" ac:schema-version="1">
<ac:parameter ac:name="name">Formattings</ac:parameter>
<ac:parameter ac:name="initialRows">3</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
<ul>
<li class="auto-cursor-target">
<ac:structured-macro ac:macro-id="13111271-327a-4c24-832e-a4f49710b041" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">Formatting</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
</li>
</ul>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="single">
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<h1 class="_2cuy _509y _2vxa" style="text-align: left;">
<span style="color: rgb(0,51,102);">Page Structure</span>
</h1>
<ac:structured-macro ac:macro-id="83486773-61a6-4dc5-848d-dfd4e2aa9c27" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">PageStructures</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>List the page structures that writers should follow in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/repeating-data">Repeating Data</a> macro.</em> </span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="2314b9a4-26bd-4922-8b09-999445fb4280" ac:name="repeating-data" ac:schema-version="1">
<ac:parameter ac:name="name">PageStructures</ac:parameter>
<ac:parameter ac:name="initialRows">3</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
<ul>
<li class="auto-cursor-target">
<ac:structured-macro ac:macro-id="8d5937f0-1c2e-4f1d-b158-465529d58f3f" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">PageStructure</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
</li>
</ul>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="single">
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
<ac:layout-section ac:type="two_right_sidebar">
<ac:layout-cell>
<h1 class="_2cuy _509y _2vxa" style="text-align: left;">
<span style="color: rgb(0,51,102);">Procedures</span>
</h1>
<ac:structured-macro ac:macro-id="072b4af2-2282-4a33-be7c-da7d14b9237b" ac:name="hidden-data" ac:schema-version="1">
<ac:parameter ac:name="whenNotEmpty">Procedures</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<span style="color: rgb(165,173,186);">
<em>List the procedures that writers should follow in this <a href="https://docs.servicerocket.com/scaffolding/macro-reference/repeating-data">Repeating Data</a> macro.</em> </span>
</p>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:macro-id="20f6fb6d-eda1-4536-80e3-a9e116154c1c" ac:name="repeating-data" ac:schema-version="1">
<ac:parameter ac:name="name">Procedures</ac:parameter>
<ac:parameter ac:name="initialRows">3</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
<ul>
<li class="auto-cursor-target">
<ac:structured-macro ac:macro-id="15fc5166-e43e-454b-93f0-4d7ad11326de" ac:name="text-data" ac:schema-version="1">
<ac:parameter ac:name="name">Procedure</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
<ac:rich-text-body>
<p>
<br/>
</p>
</ac:rich-text-body>
</ac:structured-macro>
</li>
</ul>
</ac:rich-text-body>
</ac:structured-macro>
</ac:layout-cell>
<ac:layout-cell>
<p>
<br/>
</p>
</ac:layout-cell>
</ac:layout-section>
</ac:layout>
|
|