User Stories

Searching

As a snippet reader, I want to be able to search my snippets, so that I can find them.

Searching tags

Tagging

Tag a snippet

As a snippet writer, I want to be able to tag my snippets, so that I can find them later.

Tagging may be implemented with #hashtags, which can be added/removed from the snippet's text while being eddited. For example:

This an example of a tagged snippet, created on 2017-11-28
#Tag

This snippet would be saved as

This an example of a tagged snippet, created on 2017-11-28

with the following associated tags: Tag (explicitely in the text) and 2017-11-28 (implicit). When edited again, the edited text would look something like the following:

This an example of a tagged snippet, created on 2017-11-28
#Tag #2017-11-28

Tag properties

• tags: some may have values, e.g., created_on:2017-04-23 and updated_on:2017-04-23
  • alternatively, consider created_on_2017-04-23 and updated_on_2017-04-23
    • this is explosive
    • how easy will it be to search these tags?
  • other examples: started_at_<time>, paused_at_<time>, resumed_at_<time>, finished_at_<time>

Alternatives

Entries with just the text (e.g., 08:31) and the started_at tag (and also possibly the created_on_2017-04-23 tag).

Automatic tags

• these created_on and updated_on may be created (suggested) automatically

Editing

Single snippet

As a snippet editor, I want ..., so that ...

• Title:
• Body:
• Tags:

Hash Tags

As a snippet editor, I want to write #hashtags on the text, which get automatically converted into the snippet's tag, so that I can be quicker writing.

Notes:

1. #hashtags on the text can get clumsy...

Automatic saving

As a snippet editor, I want changes to snippets to be automatically saved, so that time is saved.

• no submit button: just escape from a text-box for the change to be saved

References:

1. How to Implement Auto-Save in your Web App;

Presenting

Continuous scrolling

As a snippet reader, I want snippets to automatically appear on the list of snippets, so that I don't have to explicitly load them.

Most recently updated first

As a snippet reader, I want the most recently changed snippets to appear on top of the list of snippets, so that they can be read/edited first.

Verify with:

1. Create two snippets;
2. check that the last one created appears on top of the first one.

Tag cloud

As a snippet reader, I want to see a cloud of tags, so that I can easily see the ones that have been most commonly used.

Verify with:

1. ...

References:

1. 10 jQuery Tagging and Tag Clouds;
2. Create World Clouds in Javascript;

KPIs

As a snippet author, I want to see a a bunch of KPIs about the app, so that I can easily see how I have been performing.

Example KPIs could be:

1. Number of new snippets per day;
2. Number of updated snippets per day;

API

As a snippet user, I want to be able to access all data through an API, so that I can implement other apps.