Design doc: Landing Page User Stories #8594
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| Landing Page User Stories | ||
| ================================================= | ||
|
|
||
| This document serves to define our standard users and to map specific user needs for the landing page. | ||
|
|
||
|
|
||
| User sectors | ||
| *************** | ||
|
|
||
| +-------------------+--------------+--------------+--------------+--------------+ | ||
| | User Levels → | Potential | Beginner | Intermediate | Advanced | | ||
| +-------------------+ | | | | | ||
| | User Groups | | | | | | ||
| +===================+==============+==============+==============+==============+ | ||
| | Software Engineer | | | | | | ||
| +-------------------+--------------+--------------+ | | | ||
| | Technical Writer | | | | | | ||
| +-------------------+--------------+--------------+ | | | ||
| | Manager | | | | | | ||
| +-------------------+--------------+--------------+--------------+--------------+ | ||
|
|
||
|
|
||
| User Stories | ||
| ************ | ||
|
|
||
| A user story is an informal, natural language description of a software feature, written from the perspective of the end user or other stakeholders. The purpose is to capture ideas about what needs to be built into the application. This will help us define specific features and goals. | ||
|
|
||
| Although there's no formality to a user story, the following template is normally useful: | ||
|
|
||
| ``` | ||
| As a <role> I want to <goal> so that I <receive benefit> | ||
| ``` | ||
|
|
||
|
|
||
| Potential users | ||
| ^^^^^^^^^^^^^^^ | ||
|
|
||
| *As a potential user and a Software Engineer/Technical Writer | ||
|
There was a problem hiding this comment. If it helps to get more granular on this, it might be worth considering these two users -- engineer and technical writer -- as separate cases. However, I suspect we'd rather point these granular cases towards specific landing pages, not try to cover these in our homepage. We can talk to engineers easier than we can sometimes talk to technical writers. Our service is not unlike tools an engineer is already using, but can be more specialized tooling than other platforms technical writers are commonly using. Even core features like build automation might not be a direct requirement for some techincal writing teams, and we might have to illustrate our documentation workflow a bit more. |
||
| I need to know what Read the Docs is and how it might help me with my work.* | ||
|
|
||
| *As a potential user and a Manager | ||
| I need to know what Read the Docs is and how it might help my team workflow.* | ||
|
|
||
| ------- | ||
|
|
||
| *As a potential user and a Software Engineer | ||
| I need to know more about Read the Docs technical features and integrations, so I can know if its a good fit for my tools.* | ||
|
There was a problem hiding this comment. Also on the theme of granularity, there are two more granular users here: engineers familiar with Sphinx and the Python ecosystem, and users from other language communities. This is another case where it's more difficult talking to users who aren't familiar with the Python ecosystem. A user not familiar with the Python ecosystem would need to know if RTD can even work with their project, and perhaps would benefit from seeing a project that already uses RTD. |
||
|
|
||
| *As a potential user and a Technical Writer | ||
| I need to know if Read the Docs is easy to integrate with my tools so it helps me save time.* | ||
|
There was a problem hiding this comment. A few of the common questions/issues that we see when discussing RTD with someone in a technical writing role:
So, from the conversations I've at least had, these users were more likely to be concerned about their documentation as a product -- and the experience of that product. Also, these users were more likely to be concerned about the workflow of their team, and getting contributions from other teams. |
||
|
|
||
| *As a potential user and a Manager | ||
| I need a high level overview of how Read the Docs can be integrated with my team's tools so I can plan to make it happen.* | ||
|
|
||
|
|
||
| Beginners | ||
| ^^^^^^^^^^^^^^^ | ||
|
|
||
| *As a beginner and a Software Engineer/Technical Writer | ||
| I need to have the next step clearly pointed out so I don't loose time looking for what to do.* | ||
|
|
||
|
|
||
| Intermediate or Advanced | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| *As a intermediate or advanced user | ||
| I need to be able to able to jump fast into login or other important app pages so that I can use this page as a start point without loosing time with its marketing contents.* | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great breakdown of the different audiences 👍