Skip to content

Commit

Permalink
Tidy README.md and MVP.md closes #222
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Feb 23, 2023
1 parent 44acd24 commit 2c7abe1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 98 deletions.
81 changes: 2 additions & 79 deletions MVP.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,4 @@
# Minimum Viable Product ([MVP](http://theleanstartup.com/principles))

We're still working on this document so it should be constantly changing. _**All comments and pull requests welcome!**_

- [Minimum Viable Product (MVP)](#minimum-viable-product-mvp)
- [MVP Feature set](#mvp-feature-set)
- [Common points of friction](#common-points-of-friction)
- [Minimum UI](#minimum-ui)
- [Screens](#screens)
- [Open Questions](#open-questions)


<br/>

## MVP Feature set

[**Alpha feature set:**](https://github.com/ideaq/time/issues/67)
* Log in as a user (to enable timers to be saved)
* Log out
* Start a timer
* Stop that timer
* Give that timer a description
* Start a new timer

### Common points of friction

Day-to-day time tracking **can't feel like work** or it'll stop being an effective tool [upcoming blog post on this topic!]. What we really want is **the minimum number of steps** to accomplish our task - starting a timer.

So **what are the _biggest_ time wasters** to try and avoid?
* **Too much initial setup:** If you’re going to ask me to create all of my projects, rates or set up a bunch of timers **_up front, before I can start using the app_** in a useful way, that’s burdensome. I don’t even know _how_ I’m planning on using the app yet!
* **Too much overhead to start a timer:** Having to type a description and _then_ assign a category and _then_ decide what other options to add to my timer when really, all I want to do is start it and get on with life.

## [Minimum UI](https://github.com/ideaq/time/issues/31)

**Minimum solution to points of fiction:** Timer starts automatically when [people](https://github.com/ideaq/time/issues/33) open the app/webpage. Also allow them to start a timer _with **one tap**_ and _without_ the need to add further information to it.

### Screens
First partial UI sketch, keeping it as simple as possible. _To be iterated over._

_**Initial suggestion -**_ Minimal number and content of screens as follows:

* Main screen:
* Timer, set to 00:00 to begin with (seconds & minutes, with hours added dynamically when required)
* Description of timer with placeholder text
* Ability to edit description (added during alpha build, [issue #95](https://github.com/ideaq/time/issues/95))
* Log of stopped timers
* Simple login area, shown as default unless user is logged in already
* Additional items required at this point:
* Some way of [knowing user is logged in](https://github.com/ideaq/time/issues/85)
* Logout button

![First sketch](https://cloud.githubusercontent.com/assets/4185328/6601248/7717a73c-c80c-11e4-9a86-066934c90dce.jpg)

A few more sketches of potential **MVP alpha** screens to start understanding the user experience, leading to [more open questions](#open-questions):

![User experience screen flows](https://cloud.githubusercontent.com/assets/4185328/6856657/5f501c12-d3f9-11e4-9424-62774075afb2.jpg)


## Open Questions

Some of our UI open questions _**have**_ to be answered **before the MVP** as they touch our MVP feature set:
* Does the user need to press anything to submit/confirm the description of the timer?
* How does the user edit the timer description? Tap to edit?
* Do we need both an email and a password requested on the main screen or just an email?
* Should a new timer start automatically once a timer has been stopped?
* Do we [allow anonymous users to have run more than one timer](https://github.com/ideaq/time/issues/58) before they have to register to save them?
* What is the best way to [show a user they are logged in](https://github.com/ideaq/time/issues/85)?
* What is the simplest way to deal with [remembering users so they don't have to constantly log in](https://github.com/ideaq/time/issues/45) at MVP or should we be doing this at this stage at all?

Some initial questions **to be answered by the MVP** also surfaced whilst putting together the UI:
* Should the running/active timer take up so much screen real estate or would this be better utilised for something else?
* Should the [placeholder text for the timer description disappear as soon as a person is in the input field](https://github.com/ideaq/time/issues/92) or remain as a prompt until that person starts typing?
* How does someone edit the timer description? Tap to edit?
* How does someone [edit a _past_ timer description](https://github.com/ideaq/time/issues/103)? Especially if tapping a past timer restarts it.
* If the description wraps over more than one line, [do we show the whole description or do we cut it off](https://github.com/ideaq/time/issues/105) and add '...' at the end
* Should _past_ timers shown on main page show the total time spent on that activity for a period (today or the current week for example) or just the last time the timer was used?
* [Should just today's timers be shown on the main page](https://github.com/ideaq/time/issues/113) of the app? Or Today + Yesterday? Or the full week?
* Should past timers be shown in reverse chronological order (latest timer to have been stopped at the top/always visible without scrolling)?
* Should clicking on a _past_ timer on the main page [restart it](https://github.com/ideaq/time/issues/30#issuecomment-75047797)?
* Do we need both an email and a password requested on the main screen or just an email?
* What is the [most intuitive icon for prompting people for feedback](https://github.com/ideaq/time/issues/114#issuecomment-92297303) within the app?
Please see:
[github.com/dwyl/mvp](https://github.com/dwyl/mvp/)
49 changes: 30 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# time
[![Build Status](https://travis-ci.org/dwyl/time.png?branch=master)](https://travis-ci.org/dwyl/time)
[![Node version](https://img.shields.io/node/v/dwyl.svg?style=flat)](http://nodejs.org/download/)
[![HAPI 11.0.3](http://img.shields.io/badge/hapi-11.0.3-brightgreen.svg)](http://hapijs.com)
<div align="center">

# `app`

![Until we can manage time, we can manage nothing else](http://i.imgur.com/GbTyiib.png)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/app/ci.yml?label=build&style=flat-square&branch=main)
[![contributions welcome](https://img.shields.io/badge/feedback-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/app/issues)
[![HitCount](https://hits.dwyl.com/dwyl/app.svg)](https://hits.dwyl.com/dwyl/app)

</div>
<!--
![Until we can manage time, we can manage nothing else](http://i.imgur.com/GbTyiib.png)
-->
- - -
You *found* us, ***welcome!***
We're currently *re-building* the ***Time*** **App** to make it more modular and extensible, if you want to help us ***Beta Test*** it,
please register your interest on the website: http://www.dwyl.com/
You *found* us, ***welcome!*** <br />
We're currently *re-building* the **`App`**
to make it _much_ simpler!
If you want to help us ***Beta Test*** it,
please see:
[github.com/dwyl/mvp](https://github.com/dwyl/mvp/)

In the meantime, please feel free to [read through our repos](https://github.com/dwyl/start-here) and find out what we're about or [_drop us a line_](https://github.com/dwyl/start-here/issues) with questions, what you'd like to see us focus on, happy thoughts, great articles you've read lately or anything that's on your mind!

## Why? [![Start with Why](https://img.shields.io/badge/start%20with-why%3F-brightgreen.svg?style=flat)](http://www.ted.com/talks/simon_sinek_how_great_leaders_inspire_action)

Expand All @@ -23,34 +29,38 @@ Time (a *finite* amount it) is one of the few things we *all* have in common.
Whether we like it or not, we each only have a ***fixed amount***.
It is our most precious ***non-renewable*** 'resource'.
We need a *much* better way of keeping track of how we spend it.
˜

> More detail: https://github.com/ideaq/time/issues/19

+ Watch: **How Will You *Measure* Your Life?**
http://youtu.be/tvos4nORf_Y
+ and ***Don't waste people's time***: http://ecorner.stanford.edu/authorMaterialInfo.html?mid=3404
and **Protecting People’s Time**:
https://ecorner.stanford.edu/clips/protecting-peoples-time
+ Read ***Time is More Valuable Than Money***:
https://ecorner.stanford.edu/articles/time-is-more-valuable-than-money/


## What?

A simple way to track activities over time.
A simple way to organize your life/work
and track activities over time
so that you focus on what matters
and don't get distracted by what doesn't.

## How? [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ideaq/time/issues)

> Help us build it! https://github.com/dwyl/time/issues
> Help us build this! Your feedback is very welcome:
[/github.com/dwyl/app/issues](https://github.com/dwyl/app/issues)


<!-- uncomment this once it's been updated
### Run the Project _Locally_
+ Download Node.js: https://nodejs.org/en/download/
+ Download PostgreSQL: https://wiki.postgresql.org/wiki/Detailed_installation_guides
+ Download Redis: https://github.com/dwyl/learn-redis#installation
### _Clone_ the Repository
```sh
git clone https://github.com/dwyl/time.git && cd time
git clone https://github.com/dwyl/app.git && cd app
```
### _Install_ the Dependencies
Expand Down Expand Up @@ -79,6 +89,7 @@ To run this app you will need to have ***PostgreSQL Installed and Running*** on
***before*** you attempt to run this example.
> see: https://wiki.postgresql.org/wiki/Detailed_installation_guides
-->


### No Registration Required
Expand Down

0 comments on commit 2c7abe1

Please sign in to comment.