Creating Great Documentation From Good Documentation in Seven Steps

Automation has seemingly made API documentation an easy process. It creates reference pages directly from the code, and assemble comments just as easily. And for many status quo companies, creating adequate documentation is good enough. But raising this to the next level for great documentation that is, providing a developer experience that leaves no doubt in their mind about what to do next, requires going extra steps. Seven extra steps as it turns out.

This talk presents seven steps that go beyond automated documentation, steps that many API documentation writers overlook. You’ll understand why the developer experience is so important, how it’s important to be a client advocate, what great documentation is, and why automation alone can’t create great documents.

Content & Design
Location: Date: March 29, 2019 Time: 9:00 am - 9:45 am photo of Robert Delwood Robert Delwood