CLI and framework - Githubissues

slidewinder / direction

High-level project planning and discussion

Creative Commons Zero v1.0 Universal

0 stars 2 forks source link

CLI and framework #1

Open blahah opened 8 years ago

blahah commented 8 years ago

This is a place to discuss the direction of the CLI and framework

blahah commented 8 years ago

User personas

User community

constraints:
- programmers, or people comfortable with the command-line
who do we most need?
- right now, the main user is us as we develop the GUI
- it's quite possible others will prefer the command-line, but they are not our main target user
- ultimately we want to serve scientists who make talks, regardless of whether they are coders
- ...so, really the only user for the CLI/framework is us

Having realised this, it makes sense to focus on users of the GUI so we can build the backend to support it. Moving to develop personas in #2

blahah commented 8 years ago

from #2, some persona-based specifications for the GUI/webapp

gui should have an interactive walk-through guide

it must be easy and intuitive to:

create slides

modify existing slides

assemble them into decks

find shared slides and collections

organise slides and collections

import slides from existing decks in standard formats

users who share things should get detailed feedback about the use of their shared stuff

how many people looked (views)

how many people added them to collections (collections)

how many talks were given that contained her slides (presented)

how many people made derivative slides from hers (remixed)

similarly, these measures should be visible to people browsing or finding slides or collections, so they can for example pick out the most popular slides matching their search query

From this, we can work back to see which tasks are backend-specific, and from there spec out the API.

blahah commented 8 years ago

Backend-specific tasks from the above:

create a new slide from scratch
modify an existing slide
create a remix of an existing slide
search across one or more collections (metadata and full text)
organise slides and collections - e.g. with tags
track the heritage of a slide - i.e. it was a modification of y which was a modification of z.
- perhaps needs a unique slide ID - hash of metadata + content?
track the license information on a slide
track slide statistics
- how many talks/collections is it in?
- how many descendants?
import slides from other formats
- ppt
- open doc presentation
- keynote
- pdf
- web/JS frameworks

blahah commented 8 years ago

Tasks above have been converted to issues. https://github.com/slidewinder/slidewinder/milestones/Mozilla%20Science%20Lab%20sprint%20%231