Documentation: The Missing Pieces by Adrienne Tacke

Document all the things, they say! But are we documenting for ALL the PEOPLE? It seems that most documentation is written for the intermediate and above devs, the devs who have been around, and the devs who are already comfortable with programming.

But what about the true beginners, the career-transitioners, or those crossing domains? Most documentation is certainly not written for them!

In this talk, we'll explore

Common oversights and assumptions most documentation has built-in by default
Techniques that make our documentation more approachable for all kinds of people
How to strengthen our technical writing skills to ensure, to the best of our ability, that every anticipated reader of our documentation never feels lost or frustrated.
By the end of this talk, you'll leave and never write documentation in the same way again...and that's a good thing!

About Adrienne:

Currently a Senior Developer Advocate for MongoDB, Adrienne Tacke is also a Filipina software engineer, speaker, published author of the book Coding for Kids: Python, and a LinkedIn Learning instructor who specializes in Cloud Development courses. Perhaps most important, however, is that she spends way too much money on desserts and ungodly amounts of time playing Cyberpunk 2077.

[wilsonbombe]

This is very important and so good, I want to say great job and thanks for sharing.

[hanzlaahabib]

This is something I believe for Non-English Learners too disturbing, I am a self-taught developer and I often look 3-4 resources to grasp what exactly docs meant,
recently I had this case with DynamoDb GSI data query, but couldn't find a place where all the fields with details, different use cases, and edge scenarios are listed for reference.

no doubt there are very helpful resource too, VueJS, TypeScript, ReactJS, great docs to start with

[fatmaadam]

First thanks for sharing those great tips!
they might small steps but with huge effort help us before others.


For the 3rd point that you mentioned in unclear reasons you said we should use German naming convention, honestly I'm not totally agree with it !

yes we must use meaningful variables but explicts all details in the variables it make it less readable especially when I write in camelCase ..etc

so in my point of view I suggest to use simple meaningful variable name and add details as comment beside or down the variable that make it more clear and simple with less code.

kind regards