Tech Support Documentation Format

Hello all,

I am currently working on a project that involves converting much of our tech support documentation into confluence. This involves copying scripts over, .jars, and thing of that nature.

It seems like it would be cumbersome to just add our scripts (.txt format) as attachments to confluence.

I would think this would be a regular use of confluence and would appreciate if anyone could point me in the direction of a format to go off of.

Thank you.

2 answers

1 accepted

This widget could not be displayed.

Documentation is definitely one of the core uses for Confluence. Check out Developing Technical Documentation on Confluence as a guide. Also, Sarah Maddox, one of our Technical Writers, has a book on the subject!

As for copying, there are a couple tools to start with. The Universal Wiki Converter will convert content from another Wiki, but I think you really want the rest API, the command line interface, or possibly the SOAP API. The CLI is particularly user-friendly (as far as command line utilities go!) but if you want your own integration points, look at the rest or soap api's.

This widget could not be displayed.

Hi, I'd recommend the Confluence Code Block Macro https://confluence.atlassian.com/display/DOC/Code+Block+Macro for any scripts that you may have.

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Monday in Confluence

Why start from scratch? Introducing four new templates for Confluence Cloud

Hi my Community friends!  For those who don't know me, I'm a product marketer on the Confluence Cloud team - nice to meet you! For those of you who do, you know that I've been all up in your Co...

255 views 2 4
Join discussion

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