Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,361,334
Community Members
 
Community Events
168
Community Groups

Real-life examples of beautiful technical documentation using Confluence

Todd I'm New Here Sep 20, 2022

This blog post was written several years ago: https://www.atlassian.com/blog/add-ons/5-real-life-examples-beautiful-technical-documentation

We use Atlassian enterprise (Confluence, Jira, Trello) extensively throughout my company. I am working on a massive initiative to consolidate and demystify our internal-facing documentation. Do any more recent examples exist of user-facing knowledge bases or technical documentation using Confluence? A few of those links are now either dead or pointing to sites that are no longer using Confluence.

I would love to stick to Confluence if possible but need some more inspiring sites to reference, where companies have gotten documentation right using Confluence. 

1 answer

1 vote
Brant Schroeder Community Leader Sep 20, 2022

@Todd Welcome to the Atlassian community

Confluence is a great tool for technical documentation.  I think examples are helpful but what you really need to do is develop some standards of how you will organize your content, how it should be built out (Templates) and a process for creating and approving content.   

Here is an articles KB about technical documentation. https://confluence.atlassian.com/doc/develop-technical-documentation-in-confluence-226166494.html 

I wrote an article about knowledge bases that is very applicable to this.  I have done similar steps when setting up documentation.  https://community.atlassian.com/t5/Confluence-articles/How-to-Use-Confluence-as-a-Knowledge-Base/ba-p/2129974 

Todd I'm New Here Sep 21, 2022

Thanks, Brant! This is very helpful, and I agree that there's a lot of fundamental work that needs to happen before the "chrome." My motivation for asking for real-world examples is to show people internally what's possible, to get them bought in on using Confluence for this reason. Some people might've had bad experiences with Confluence as a knowledge base because of poor digital hygiene, and that bias has to be overcome. It's easier to battle that by showing the end state that's possible. That all said, I will certainly study the helpful links you shared. 

Brant Schroeder Community Leader Sep 21, 2022

@Todd makes sense.  You might take a look at Teams 22 content.  There might be some digital content that you could share.  They have a bit of on-demand content that you can still watch.  https://events.atlassian.com/team22/on-demand-library  

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
TAGS
Community showcase
Published in Confluence

Watch 4 Confluence apps compete for Best App Demo in September's Appy Hours

Calling all collaborators! Appy Hours on the Atlassian Community is a monthly event where 4 Partner and app vendor presenters go head-to-head with 5-minute demos for the title of Best App Demo. I...

586 views 0 13
Read article

Atlassian Community Events