DEV Community

Cover image for New Series: 10 Minute Docs Audits
DocumentWrite
DocumentWrite

Posted on • Edited on

New Series: 10 Minute Docs Audits

QuickStarts are the first thing that your users interact with. It's important to make a good impression. In this series, we are going to spend 15 minutes with a Quickstart and give you our review.

For many tech companies, QuickStarts are the landing page in the documentation world. You are more likely to persuade users to sign up for a demo or implement your software when you give them a good experience.

The problem is there aren't many resources that explain how to distinguish a good Quickstart from a bad one. That's where this series comes in. Starting on October 9th, we're going to spend 30 days reviewing different Getting Started Guides.

What's The Criteria?

- Excellent
- OK
- Poor

Purposeful: Does the QuickStart explain what problem it's trying to solve? Who is the intended audience?

UX Experience: How seamless is the experience? Must the user create an account to get through the Quickstart? Does the Quickstart elicit a sense of joy and achievement?

Accurate: Are the instructions correct? Are they complete?

The purpose of this series is for the tech community to gain clarity on how to create a great Getting Started Experience. We'll learn what works, and what we can improve upon together as a community.

DocumentWrite QuickStart audit

If you're interested in a FREE Getting Started audit for your company, please fill out this form.

Reinvent your career. Join DEV.

It takes one minute and is worth it for your career.

Get started

Top comments (0)

👋 Kindness is contagious

Immerse yourself in a wealth of knowledge with this piece, supported by the inclusive DEV Community—every developer, no matter where they are in their journey, is invited to contribute to our collective wisdom.

A simple “thank you” goes a long way—express your gratitude below in the comments!

Gathering insights enriches our journey on DEV and fortifies our community ties. Did you find this article valuable? Taking a moment to thank the author can have a significant impact.

Okay