Create Technical help documentation

As mentioned on the confluence page it's possible to use Confluence to create a Technical help documentation. I understand and know how to create a single page in Confluence. However I do not understand how I can create something like these companies have done: https://www.atlassian.com/blog/add-ons/5-real-life-examples-beautiful-technical-documentation

Could someone help me out please?

Thanks

1 answer

1 vote
Susan Ostreicher Community Champion Nov 13, 2017

Hi John, 

Can you be more specific about what you see in these examples that you're not sure how to replicate? 

Thanks!

I would like to create a Treeview for public users to have the ability to navigate and browse through help documentation. 

In short this is the current documentation for a tool I publicly share that people use. http://boomerlabs.com/vexus_dir/documentation/

I would like to move this documentation into something more clean and professional looking which would be confluence. But I'm not clear on how I would do that and make it so users have public access to browse the documentation.

Susan Ostreicher Community Champion Nov 13, 2017

Hi John, 

Thanks, that helps.

Regarding the tree view, Confluence automatically puts the pages you create into a hierarchy.  You can read about how to edit the hierarchy by moving and re-ordering pages here: 

https://confluence.atlassian.com/doc/move-and-reorder-pages-146407727.html

That said, if you're using the Cloud version, the page tree became pretty difficult for end-users to find when the UI was changed a couple months ago.  Some users have requested the option to always show the page tree, and you can follow that request here: 

https://jira.atlassian.com/browse/CONFCLOUD-56841

Regarding public access, you can read more about setting it up here: 

https://confluence.atlassian.com/doc/setting-up-public-access-156.html

Hope some of this is helpful!

I'm not quite sure the page links you gave me help achieve what I'm after. Here is a live example of what I want to do. Create an online doc help where users can freely browse and view the help.

https://support.allegorithmic.com/documentation/pages/viewpage.action?pageId=129368169

I noticed when I made my test project publicly accessible it doesn't display like the one in the link provided. With a treeview on the left and Read only access.

Susan Ostreicher Community Champion Nov 20, 2017

Hi John, 

Are you using Cloud?  Unfortunately, the page tree became pretty difficult for Cloud users to find when the UI was updated a couple months ago.  You have to have the sidebar expanded (hover and drag right), and the page tree is not shown on the overview page anymore.  Many users are frustrated about this, and the best place to follow and join the conversation is through this request:

https://jira.atlassian.com/browse/CONFCLOUD-56841

Regarding public access, if you're seeing that anonymous users are able to edit pages, then you could start by going to Space Tools > Permissions to make sure that anonymous users only have permission to view.  

Hope this is helpful,

Susan

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Oct 09, 2018 in Confluence

Introducing Praecipio Consulting, an Atlassian Solution Partner

Hey there Community!  My name is Vannya Vallejo, the Channel Communication Specialist at Atlassian and I want to help Atlassian users like you learn about our Solution Partners and how they c...

374 views 0 9
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you