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

Learning Resources for Technical Writing?

Does anyone have any good recommendations for becoming a better technical writer? 

I am looking around at other popular knowledge bases and blogs to try and figure out how to best structure technical documents and the kind of templates to use. 

I was hoping like many things in Technology, there would be a book, training course, video etc. to help me and our team become better at writing project documents, technical solutions, instructional documents etc. 

This is only related to IT to IT documentation and not comms to End Users. 

3 answers

I'm not a technical writer by education or job profile. My starting background is software developer with the need to move information from the "developing layer" to other stakeholders.

We have compiled some values, principles, and practices we encountered through the years on our Agile Documentation space. This is somewhat related to one of our products, but they are quite abstract and should be useful for any toolset.

So much for the context of my answer: :-)

This space also lists some of the most interesting books concerned with technical writing and information architecture I have encountered trough the years that have been very useful to me - strictly personal view. Note that the listing is in alphabetical order (and the heading is clickable -- proofing that I'm still working on improving my skills).

Thank you for sharing your website and the list of books. 
I shall take a look at the The Insider's Guide to Technical Writing, that looks very interesting. 

Thank you for your feedback!

0 votes

@Josh Wright I moved this into our Training & Certification interest group as you might get some additional good answers here!

My recommendation would also be to look into HDI's KCS Courses and Training - they will help out a ton when it comes to formatting and what to include in Knowledge Articles and Technical Documentation.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Training & Certification

Atlassian University Live: Jira Workflows Demystified

  Atlassian University Live webinars provide you and your teams with the chance to strengthen your Atlassian product skills and learn directly from Atlassian experts. Our next webinar is tit...

128 views 1 8
Read article

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