This article contains 2 images. You will find them at the very end of the article.

This article contains 591 words.

Summit '22 session spotlight–Technically speaking: improve your code with documentation - Web Directions

Summit ’22 session spotlight–Technically speaking: improve your code with documentation

John Allsopp

26th September, 2022

@johnallsopp

Technically speaking: improve your code with documentation

Well-written instructions, informative code comments, thoughtful READMEs, and content strategy can take complex code and make it accessible to all developers. Documentation is the key to teaching the next generation of developers, passing work to successors, and helping developers better understand their own work.

When I was an engineer, docs created by my colleagues were crucial to quick onboarding and ramping up on complex internal systems. Now, as a full time technical writer, I rely on our engineers to be able to concisely explain how features work so I can further improve the documentation experience. The documentation is best when everyone, developers and product, feel empowered to write documentation.

Alexandra White

Alexandra is a technical writer for Google Chrome. In this role, writes documentation for Privacy Sandbox and acts as a co-chair of the documentation accessibility working group. Prior to Google, she was a technical writer, a web developer, and a digital marketer.

Alexandra has a bachelor’s degree in professional writing with an emphasis in digital and technical writing from Michigan State University.

Platinum

inc workshop or code leaders

Web Directions Summit

Conference Videos

Code Leaders or Workshop

$1695 super early bird ends Sept 30

$1795 early bird ends Oct 28

$1995 late bird

Register Platinum

Silver

Summit + Conffab

Web Directions Summit

Conference Videos

Conffab Plus Annual

$1495 super early bird ends Sept 30

$1595 early bird ends Oct 28

$1795 late bird

Register Silver

Classic

Summit with Videos

Web Directions Summit

Conference Videos

$1295 super early bird ends Sept 30

$1395 early bird ends Oct 28

$1595 late bird

Register Classic

Great reading, every weekend.

We round up the best writing about the web and send it your way each Friday morning.

delivering year round learning for front end and full stack professionals

Learn more about us

I’ve been admiring the Web Directions events for years, and was honored to be part… What a fantastic event!

Ethan Marcotte Inventor of 'Responsive Web Design'

Each year we have 6 unique online conferences for front end developers, plus Remixed, a free event that brings together some of the highlights from the previous year.

The conference CSS deserves

Online, globallyApril 2022

Learn More

a conference on front end performance

Online, globallyMay 2022

Learn More

a conference all about JavaScript

Online, globallyJuly 2022

Learn More

a conference on progressive web apps and web platform

Online, globallyearly 2023

Learn More

accessibility engineering for front end developers

Online, globallyearly 2023

Learn More

privacy, security, identity for front end developers

Online, globallyearly 2023

Learn More

The best of 2022, remixed, and free!

Online, globally2023

Learn More