Jordan Miller

Software Engineer at Vouch.io

Jordan Miller is an autodidact, a she/her, a modern dev, a dev for the millennium. She enjoys cats, clojure(script) and community building. Sometimes known by her online pseudonym "Lambduhh" she is a Cognitect sponsored content creator, podcast host, conference speaker and organizer (and soon to be author!) She resides in sunny Sarasota, FL where you may catch her spinning fire hoop, doing aerial dance, practicing circus arts or inspiring others by producing instructional technical content on multiple platforms. Here are some places to find her content https://linktr.ee/lambduhhh

How to Find the Right Rhythm for your Software Composition

**Creating software is like composing a symphony,

Every note a line of code and every abstraction a harmony.

Layering instruments and sounds, we carefully craft our piece,

Adding in features that bring our work to life and (hopefully) prod release.

But the right command we must click to create a unified sound,

or else we try to put it all together but no rhythm will be found.**

As software composers, when we create documentation arrangements to guide others in performing our piece our job becomes significantly easier and our prose becomes much more effective if we begin by considering our users' interests, needs and experience levels. This results in higher-quality documentation, blog posts and technical presentations.

After this session, you will know how to compose documentation and other software artefacts that empower your audience and improve the adoption and support of your product.

OBJECTIVES

Get on the same page (pun intended) about how to write high-quality, useful technical documentation. By the end of session, we'll understand that documentation is not just ONE thing (hint: one readme/spec ain't going to cut it), but 4 distinct things. We'll understand how to categorize which type you're writing and be able to scope your doc artefact's objective based on the most important thing: user need.

Outcomes (cp from slide):

1. Shared understanding of the different types of documentation

2. Appreciation of Audience Awareness - who benefits from each document artefact type?

3. Documentation artefacts become easy to create, are consistent in format and easy to find and update.

AUDIENCE

Everybody in tech.

←Back