Project 12
Training exercise.
What made you smile?
Every user review was successful in general. Some people were really excited.
Most of negative feedback was related to existing user habbits.
Getting started guide was greately improved since the first interview.
What did you find confusing?
Redocly is mostly known for openAPI UI but we don't showcase api-related features in getting started guide.
User interview notes
Kevin Lewis
- bug: link checker showed as skipped on Activity page instead of compled
- feature request: create files with folders e.g @theme/styles.css
- confusion: cmd+s opens changes tab
- feature request: commit message suggestion
- skip link account for login with workflows
- idea: add description textbox with ready for review button
- External links in documentation are the same as internal open
Did you learn something interesting from the video not mentioned in the summary? If so, what was it?
- suggestion to focus on openAPI realated-features in Reunite (like api docs, sidebar)
- feature to create nested files
Robert Delwood
- confusion: git flow differences (PR created automatically, PR title, no staging files, branch auto-deletion)
- docs: inconsistent in target audience (sometimes go into detail about pressing a button and sometimes assumes prev. knowledge)
- docs: don't teach how to create a file several times
- docs: not clear what Reunite and Realm are
- feature request: copy file name
- idea: rename WYSIWYG (maybe to Live preview)
- feature request: close button for branch manager
- docs: border for images in docs to understand where image ends
Did you learn something interesting from the video not mentioned in the summary? If so, what was it?
- In docs we say "Before you make any changes to your project, you should create a new branch." but this is not required