How to Read Technical Documentation for Software Engineers

How to Read Technical Documentation for Software Engineers

HomeIjemma OnwuzulikeHow to Read Technical Documentation for Software Engineers
How to Read Technical Documentation for Software Engineers
ChannelPublish DateThumbnail & View CountDownload Video
Channel AvatarPublish Date not found Thumbnail
0 Views
Knowing how to sort and read documentation is probably the most underrated skill as a software engineer. In this video, I review the steps I often follow when working with documentation.

Documentation is a rich source of information about any piece of technology you use. For this reason, documentation is a great resource to use when you're trying to implement a new feature, optimize a workflow, or get out of a bug.

The tips I share in this video are a combination of things I've found over my years of programming as well as opinions and experiences from others in the tech community.

Don't forget to take advantage of non-documentary resources like Medium, YouTube, and StackOverflow to help advance your development process. Additionally, I find that using code playgrounds like JSFiddle and CodePen allows me to tinker with new features without involving my code base.

Subscribe to the channel! – https://www.youtube.com/channel/UC-db2t_fVN3T_kzKYSNUioA?view_as=subscriber&sub_confirmation=1

== Resources ==
Twitter feed – https://twitter.com/ijemmaohno/status/1275059216059785220
Medium – https://medium.com
JSFiddle – https://jsfiddle.net
CodePen – https://codepen.io

Timestamp:
0:00 Introduction
1:05 What is documentation?
3:37 Tip: Identify your favorite documents
4:45 p.m. Step 1: Identify your situation
5:38 Tip: rely on outside sources
6:58 Step 2: Find useful documentation
7:33 Tip: Set document expectations
8:31 a.m. Step 3: Reading the documentation
10:33 Tip: Use the table of contents and links
12:03 Tip: Provide feedback
12:44 p.m. Step 4: Reading the documentation
13:11 Tip: Start at the top
14:18 Syntax definitions
16:21 Tip: Use Code Playgrounds
16:59 Tip: Patience is key

==Let’s connect ==
Twitter – https://twitter.com/ijemmaohno

== Who I am ==
My name is Ijemma, a front-end software engineer currently working in New York. I make videos on everything related to JavaScript and, more broadly, frontend web development.

#javascript #webdevelopment #softwareengineer

Please take the opportunity to connect and share this video with your friends and family if you find it useful.