DEV Community

Cover image for Starlight: 10 Minute Docs Audit
DocumentWrite
DocumentWrite

Posted on • Edited on

Starlight: 10 Minute Docs Audit

Starlight is a documentation platform based on the Astro. It similar to Docusaurus, but you aren't forced to use React.

I run a technical documentation business specializing in writing and editing documentation. I made this series to share my insights and help projects craft impactful documentation.

What's The Criteria?
3- Excellent
2 - OK
1 - 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 Results

Starlight's user experience game is strong. The cli was colorful and delightful to use. I didn't have to install another framework, and when I was finished running the script, I had a Hello World project up and running.

That being said, I'm not sure what Starlight is adding in the documentation framework world that doesn't already exist. The landing page lists a ton of features, but it fails to explain why I should give it a try.

Score
Purposeful 2
UX Experience 2.5
Accurate 2

Are you interested in a FREE Quickstart audit for your company? Start here.

Top comments (0)