DEV Community

Cover image for Remix: 10 Minute Docs Audit
DocumentWrite
DocumentWrite

Posted on

Remix: 10 Minute Docs Audit

Remix is a JavaScript full-stack framework that allows developers to write frontend and back-end code. The framework was recently acquired by Shopify.

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

Not sure what inspires someone to get up one morning and say, "Yes, I'm going to build another JavaScript framework," but here we are. That being said, I liked Remix's doc's landing page. I was up and running in less than 3 minutes. I think Remix is trying to solve for performance, but I'm not sure. The landing page was full of buzzwords such as "focused on web standards" and "modern web app UX." I wish I could say I care about web standards, but honestly, I want to code up a website in an afternoon and keep it moving. Perhaps I'm not the target audience?

Score
Purposeful 1.5
UX Experience 2
Accurate 3

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

Top comments (0)

This post blew up on DEV in 2020:

js visualized

🚀⚙️ JavaScript Visualized: the JavaScript Engine

As JavaScript devs, we usually don't have to deal with compilers ourselves. However, it's definitely good to know the basics of the JavaScript engine and see how it handles our human-friendly JS code, and turns it into something machines understand! 🥳

Happy coding!

👋 Kindness is contagious

Explore this insightful write-up, celebrated by our thriving DEV Community. Developers everywhere are invited to contribute and elevate our shared expertise.

A simple "thank you" can brighten someone’s day—leave your appreciation in the comments!

On DEV, knowledge-sharing fuels our progress and strengthens our community ties. Found this useful? A quick thank you to the author makes all the difference.

Okay