Forem

Cover image for Reflex: 10 Minute Docs Audit
DocumentWrite
DocumentWrite

Posted on

1

Reflex: 10 Minute Docs Audit

Reflex is a Python framework that allows developers to create 100% Python web apps (no JavaScript required).

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

Tons of fumbling. Not sure who was the bigger problem, me or the docs. First, I was having trouble setting up venv. Then, it took me some time to install Reflex. All that effort and all I got was an error message when I ran the Reflex Init command. 😭

How can Reflex improve? Please list how to create and activate venv, don't make users have to fumble through the official Python docs. Also, if reflex init really is broken, please fix it ASAP.

Things that Reflex did well? Loved the docs intro. It was obvious that this application was for Python devs who don't want to deal with JavaScript!

Score
Purposeful 3
UX Experience 2
Accurate 1

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

👋 While you are here

Reinvent your career. Join DEV.

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

Get started

Top comments (0)

👋 Kindness is contagious

Discover a treasure trove of wisdom within this insightful piece, highly respected in the nurturing DEV Community enviroment. Developers, whether novice or expert, are encouraged to participate and add to our shared knowledge basin.

A simple "thank you" can illuminate someone's day. Express your appreciation in the comments section!

On DEV, sharing ideas smoothens our journey and strengthens our community ties. Learn something useful? Offering a quick thanks to the author is deeply appreciated.

Okay