Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Next challenges

Recent achievements

  • Global
  • Personal

Recognition

  • Give kudos
  • Received
  • Given

Leaderboard

  • Global

Trophy case

Kudos (beta program)

Kudos logo

You've been invited into the Kudos (beta program) private group. Chat with others in the program, or give feedback to Atlassian.

View group

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Does anyone have documentation regarding the best design/formatting practices for Confluence Article

Such things as: using different colored headings, using expanding text vs a long expanse of text to scroll through, using the various colored notations, etc.  

We have folks in our group that have differing opinions about what works best for users.

2 answers

0 votes

Hi @Kelley Bennett 

I guess it depends on what the Confluence page or article contains.

For example, we have an FAQ page which utilises expand boxes, so users can look for their question and expand it to see the answer. It was preferred to a page with a significant amount of wording on it.

However, for a Knowledge Base article, we try to avoid expand boxes so the instructions are more searchable from either on the page or the search bar.

Things I would suggest:

  • Expand Boxes: These are great for holding tips, tricks or additional information if it's too long - for example, a template for a user to copy.
  • Panels: Good for tips, tricks, introductions to sections, etc. I use these on Knowledge Base articles to highlight "hot tips"
  • Headings: I use headings to split work into sections, as headings have anchor links (which we can place on other pages / in bookmarks) and can be used with the table of contents macro.
  • Page Properties / Page Properties Report: Good for providing a summary of multiple pages in one place

Ste

Hey @Kelley Bennett

You might also consider writing in what technical writers refer to as "topics". Essentially, it's a way of grouping similar types of content and helps avoid long scrolling pages. There's some info on my team's guide here: https://www.k15t.com/rock-the-docs/creating-topics

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
PERMISSIONS LEVEL
Site Admin
TAGS
Community showcase
Posted in Confluence

What do you think is the most *delightful* Confluence feature? Comment for a prize!

- Create your own custom emoji 🔥 - "Shake for Feedback" on mobile 📱 - An endless supply of GIFs via GIPHY 🤩 Is there anything quite as nice as a pleasant surprise? Comment below with what...

302 views 23 8
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you