Skip to content

Features and screens TBD

Damian Betebenner edited this page Apr 26, 2016 · 5 revisions

General Guidelines

  • Because we are building upon GitHub, I'd like to borrow from/steal from/be fairly consistent with their design ideas.
  • E.g., How does GitHub initiate a new repo. What can we steal from that process for starting our own new project?
  • GitHub doesn't have social media sharing functionality. Medium opens up a small modal window. What about a semi-transparent overlay? What other possibilities are there?

Project licensing

  • One step of a new project wizard
  • What about editing in existing project? Manual file editing for the time being until a frequent use case emerges that requires exposing that functionality in the UI.
  • Choose from list of common licenses
  • Need to integrate author name, copyright year, etc?

Twitter authentication

  • Is this preferable to opening twitter.com in a new window?
  • Half to full day of dev time purely for OAuth flow
  • How does that fit into existing UI?

Document editing

Multiple document formats

  • Tufte layout versus standard, etc.
  • Tufte layout requires certain document structure. Creating that structure from scratch is easy, converting existing doc would be manual.
  • This last requirement makes me wonder whether document format should only be available via manual editing of files versus being available in the UI. In general, think added features should first be tested via manual editing of files and as the use case becomes something that gets used, expose that feature in the UI.

Project filtering

  • Easier project naming (to avoid the Gist label)
  • Presumably, landing and user home pages will display a lot of projects
  • Enabling filtering by keyword improves project discoverability
  • Could also enable bookmark-able filtered pages

Admin controls

  • In general, only expose Admin controls in the UI after we have tested them via manual file editing
  • User and project level admin needed
  • User level admin
  • Specify projects to hide from Literasee
  • Default license type?
  • Default report style?
  • Project level admin
  • Change license?
  • Change layout type?