Update/Expand What Section of README.md issue #9#13
Conversation
|
@iteles if/when you have time, please review and give any feedback. Thanks. 📥 |
…on/answer to end of README.md as it breaks the flow #9
iteles
left a comment
There was a problem hiding this comment.
@nelsonic This is fantastic, thank you for capturing all this (hahaha)
There are 2 comments about typos but the rest of my comments are just notes about things I would like to add myself in the coming days.
Do you want to correct these 2 typos before I merge the PR? Or shall I go ahead and merge and then I can correct them asap when submitting my next PR?
| on working towards the collective ***goal***. | ||
| Having a _clear_ **Product Roadmap** is ***essential*** | ||
| to help ***everyone*** _focus_ | ||
| on our collective **goal**. |
There was a problem hiding this comment.
👍 A fan of how succinct this 'why' is
There was a problem hiding this comment.
Yeah, had to tighten it. 👍
| and/or guarding the user-feedback, | ||
| they are _stuck_ in the _old_ mindset. | ||
|
|
||
| they are _stuck_ in a _fixed_ mindset. |
There was a problem hiding this comment.
I want to add something in here about how the goal is not to safeguard our own profits or ability to make money. We need to be sustainable but the more people working towards a world where people are not overwhelmed, riddled with anxiety and always lifting each other up, the better.
There was a problem hiding this comment.
@iteles agree with the sentiment of putting people before profit while being sustainable. 👍
I feel that is more suited to https://github.com/dwyl/start-here/blob/master/manifesto.md 💭
| Public on GitHub is a good or bad idea, we think it's | ||
| worth the _experiment_ just to discover the outcome. | ||
|
|
||
| ### Why Do So _Few_ Companies Make Their "Road Map" Public? |
There was a problem hiding this comment.
I like that this was removed. I think it distracts from the main message and the two paragraphs above say all that is needed in a much more concise way 👍
There was a problem hiding this comment.
@iteles moved to the end of the doc; not removed entirely.
README.md
Outdated
| whereas a reading list item could be "daily commute"<br /> | ||
| **d)** **Add** any additional ***detail*** you can think of at the time. | ||
| e.g: acceptance criteria, deadline, dependencies <br /> | ||
| **d)** If the item is a task that has sub-tasks, create and link them. |
There was a problem hiding this comment.
This should be e.
Also, Linking them definitely belongs here but splitting a task out into actionable steps doesn't really belong here. It will evolve.
| **d)** **Add** any additional ***detail*** you can think of at the time. | ||
| e.g: acceptance criteria, deadline, dependencies <br /> | ||
| **d)** If the item is a task that has sub-tasks, create and link them. | ||
| 3. ***Complete*** - do the work to _complete_ the item/task.<br /> |
There was a problem hiding this comment.
This is a very big section. Whereas the first 2 'C's are small, independent actions, this one can involve a lot of different steps and take a long time depending on dependencies (i.e. if you're not doing the work yourself or waiting for bureaucracies). We'll eventually need to split this out but it doesn't have to be done now.
There was a problem hiding this comment.
@iteles yeah, the first two steps are relatively succinct and the third is where the real work is done.
I very much want the Product Manager/Owner to take responsibility for the "Workflow" and get feedback from people using the app. Ultimately the App will succeed (or fail) based on the simplicity (or complexity) of the workflow (getting the text of a "brain dump" to be a task/reminder/etc. and then getting it to done as effectively as possible)

README.md
Outdated
| will be _personalised_ to the individual | ||
| based on the features they (_most_) _use_. | ||
| If the person does not _use_ a particular function, they won't _see_ it. | ||
| > Note: This is might not feel relevant during "MVP", |
There was a problem hiding this comment.
🙌 This will of course be coupled with a discovery section where people can take a look at other features
There was a problem hiding this comment.
Agreed. That's going to be one of our USPs. Each feature will have a walkthrough demo/video that will explain why the feature exists, who it's for and how to use it. 💡
| 1. **Use** the **_Beta_ App**! | ||
| `[insert app link here!]` | ||
| 2. Give us ***feedback*** on the **_existing_ UX** | ||
| `[insert feedback link here!]` |
README.md
Outdated
|
|
||
| #### MVP Basic Workflow | ||
|
|
||
| + [ ] Mobile First UI/UX to **Capture** **`plaintex`** |
There was a problem hiding this comment.
plaintext (also needs correcting in the lines below)
There was a problem hiding this comment.
plaintex -> plaintext typos fixed in 3 instances. thanks for spotting. 👍
| of everything that is occupying space and processing power | ||
| is _essential_ for gaining focus | ||
| on the _one_ most important priority. | ||
| This step is often referred to as a "brain dump". |
There was a problem hiding this comment.
I would add a note here also about how having a trusted place to keep all of your thoughts is the only way to truly empty your mind. If you have scattered post-it's or a system that makes it difficult to view what needs to be done, the fear of forgetting something keeps everything in RAM anyway.
There was a problem hiding this comment.
@iteles yes, please refine as you see fit. 📝
My objective was just to get something down for the PM/PO to work with. 👍
| of capturing free text (_using a **`textarea`** element_) | ||
| and safely storing it as **`text`** in Postgres. | ||
|
|
||
| Figma wireframe: https://www.figma.com/proto/WrpkKGJNYZbeCzMRDVtvQLbC/dwyl-app |
There was a problem hiding this comment.
How do we signal that we have finished typing and want to move onto the next item?
There was a problem hiding this comment.
@iteles great question! Please capture it in an issue: https://github.com/dwyl/app/issues
|
|
||
| And finally for the _third_ step, ***Complete***, | ||
| we will build a simple checklist system. | ||
| See: [`checklists.md`](https://github.com/dwyl/product-roadmap/blob/master/checklists.md) |
There was a problem hiding this comment.
I've noticed a few typos on the checklist document, I'll create a new PR to fix them.
There was a problem hiding this comment.
@SimonLab yes, please do fix when you have time. thanks. 👍
README.md
Outdated
|
|
||
|
|
||
|
|
||
| ### USP: What is _different_ about the @dwyl App? |
There was a problem hiding this comment.
Sub title not displayed correctly. Looking why it's broken.
Also the USP meaning wasn't obvious to me and had too google it. We can write it down fully (Unique Selling Point/Proposition) or link it to the wikipedia page: https://en.wikipedia.org/wiki/Unique_selling_proposition
There was a problem hiding this comment.
@SimonLab please edit it to help clarify it for others. thanks. 👍
There was a problem hiding this comment.
Sorry just saw the link to the Wikipedia page just under.
…nLab 👍 Co-Authored-By: Simon <[email protected]>
Co-Authored-By: Simon <[email protected]>
Co-Authored-By: Simon <[email protected]>
Co-Authored-By: Simon <[email protected]>
Co-Authored-By: Simon <[email protected]>
Co-Authored-By: Simon <[email protected]>
|
@SimonLab thanks for taking the time to review this PR in such great detail and propose changes. 👍
|
|
👍 Thanks both! |


This Pull Request Addresses the question raised by @Cleop in issue #9 💭
README.mdto add clarification in the "What" section for What? section - should this be more detailed? #9capture.mdto describe the MVP version of the first step/screen in our app for #12How?section of readme for Tidy up "How?" Section of README.md #16I feel these docs are more readable now.
@iteles Please review and give feedback if possible.