Anchor | ||||
---|---|---|---|---|
|
This style guide is an example of what customer-facing user guides should look like and how they should be structured. It includes best practices for user guides as well as instructions on how to navigate Confluence (Cloud and On-Prem) to add macros and a table of contents to your page that will function both in Confluence and Jira Service Desk Customer Portal.
Each user guide should have an Overview section, a Table of Contents (TOC), and an Instructional Section. The setup should mirror this guide.
Info | ||||
---|---|---|---|---|
| ||||
Anchor | ||||
---|---|---|---|---|
|
Using headings
- Highlight text you want to apply the heading to
- Select the Normal text drop down
- Choose your heading (Normal text, Heading 1, Heading 3)
Info | ||
---|---|---|
| ||
|
Creating links to the Top of Page Anchor
- Type 'Back to top' at the end of each section
- Highlight the 'Back to top' text
- Select the Link Link icon
- Type #Top and then press Enter
Info | ||
---|---|---|
| ||
|
Anchor | ||||
---|---|---|---|---|
|
Writing step-by-step instructions
- Select the Numbered list icon
- Write instructions
- Bold and capitalize the Name of buttons and other options that the user is instructed to select
Info | ||
---|---|---|
| ||
|
Adding a panel
- Select the Insert (Plus sign) drop down
- Type 'panel' into the search bar
- Select the wanted panel from the results
- Type in bold the title of the panel if desired
- Type the information within the panel
Editing a panel
- Select the panel to be adjusted
- Edit the wanted text
- Select anywhere outside of the panel once editing is complete to exit the editor
Removing a panel
- Select the panel
- Select the Remove (Trash can) icon
Info | ||
---|---|---|
| ||
|
Anchor | ||||
---|---|---|---|---|
|
Inserting pictures
- Place the cursor where the file or image is wanted
- Select the Files & Images icon
- Navigate to the location of the wanted file or image
- Select the wanted file or image
- Select the Open button
Info | ||
---|---|---|
| ||
|
Sizing images in Confluence
- Select the image
- Drag the handles on either side of the image to decrease or increase the image size.
Info | ||
---|---|---|
| ||
|
Adding alt text to pictures
- Select the image
- Select the Alt text text in the floating menu by the image
- Enter a short description of the image
- Press Enter or select anywhere outside of the image to save the entered information
Info | ||
---|---|---|
| ||
|
Anchor | ||||
---|---|---|---|---|
|
Making your Table of Contents
- Add Info panel
- Place your cursor next to your first Heading 1 title on the right
- Select the Insert (Plus Sign) icon drop down
- Type 'anchor' in the search bar
- Select Anchor under the search bar
- Type the name of your anchor (e.g. Topic1) in the pop-out on the right side of the screen in the Anchor Name field.
- Repeat steps 2-6 for the remainder of your Heading 1 and Heading 3 titles
- Type your Heading 1 and Heading 3 titles in the Table of Contents space
- Highlight the first title
- Select the Link icon
- Type # and the name of the anchor you made for that title (e.g. #Topic1) and then press Enter
- Repeat steps 8-11 for the other titles
Info | ||
---|---|---|
| ||
|