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
Community Members
Community Events
Community Groups

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

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.

0 votes
Monique vdB Community Manager Feb 26, 2018

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

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!

Suggest an answer

Log in or Sign up to answer

Atlassian Community Events