Welcome to the Treehouse Community

Want to collaborate on code errors? Have bugs you need feedback on? Looking for an extra set of eyes on your latest project? Get support with fellow developers, designers, and programmers of all backgrounds and skill levels here with the Treehouse Community!

Looking to learn something new?

Treehouse offers a seven day free trial for new students. Get access to thousands of hours of content and join thousands of Treehouse students and alumni in the community today.

Start your free trial

General Discussion

Posted by Sako Kassabian
Sako Kassabian
13,796 Points

Any resources on 'How to write technical documentation correctly' ? Wish there was a course on this on here.

I'm starting to document some of the systems that we have built (we have limited resources so just catching up). Are there any good resources on what I should include when writing these?

Michael Lau
Michael Lau
Courses Plus Student 26,298 Points

X2 Any resources on 'How to write technical documentation correctly' ? Wish there was a course on this on here.

2 Answers

jason chan
jason chan
31,008 Points
jason chan
jason chan
31,008 Points

Just write it for a 3 or 5 year old. Don't use too much tech jargon. Pretend your teaching a little kid. Explain it in different way. I hope that helps. Just have pictures and videos.

Edward Glasheen
Edward Glasheen
5,852 Points
Edward Glasheen
Edward Glasheen
5,852 Points

LOL, sorry but your answer did not help at all. Working with developers in many disciplines, I see technical writing a huge challenge and a gap in skill sets that needs to be addressed. I would hope a response from Treehouse would be a little more professional than "write for a 3 or 5 year old".