Parcourir la source

more user tasks added

faricacarroll il y a 8 ans
Parent
commit
b8da5ad32b
1 fichiers modifiés avec 69 ajouts et 78 suppressions
  1. 69 78
      design/notebook.md

+ 69 - 78
design/notebook.md

@@ -1,85 +1,76 @@
-# Design of the Notebook Plugin
+# Design of the notebook plugin
+This document describes the design of the Notebook plugin. This document illustrates how our research on personas and other solutions translates into the design decisions made to improve the Notebook plugin.
 
-This document describes the design of the notebook. This document illustrates how our research on personas and other solutions
-translates into the design decisions made to improve the notebook plugin.
+# Personas
+### Jane Gomez
+Jane Gomez has never used the Jupyter Notebook before. She has some basic understanding of python, but only knows how to write simple functions. She’s using the notebook for the first time in JupyterLab and wants to quickly learn how to use it.
 
-## Personas
+**Goal:** Jane can quickly learn how to use the notebook through an intuitive menu bar and/or a tour.
 
-### Experienced Data Scientist
+### Shane Alborou
+Shane Alborou has used Jupyter Notebook in a classroom setting in the past. He wants to use the multiscreen JupyterLab to write his code and submit it to his professor. 
 
-The experienced data scientist is familiar with the Jupyter Notebook and uses it regularly. He has become accustomed to the shortcuts
-and toolbars. He uses the notebook to take measurements from plants and identify the species based on those measurements alone.
-
-**Goal:** Use the Notebook to display his various visualizations for his data
-
-Some things they would in the notebook include:
-* Create a scatterplot matrix
-* Import data into a pandas DataFrame
-* Convert measurements in the data with programming
-* Cleaning up the data
-* Program the mean imputation
-* Save the data file
-* Save a copy
-
-### Student using the notebook in a programming class
-
-The student is a first-year cs major who is taking a course where the professor wants his students to use JupyterLab to write
-their code and print it out. He has never used the Jupyter notebook or JupyterLab before.
-
-**Goal:** Make it easy for this student to learn how to use the Jupyter notebook to complete his assignments
-
-Some things they would do in the notebook include:
-* Write basic programs and output them
-* Save the notebook
-* Print it out
-
-## User Tasks
+**Goal:** The student can use all of the same functions that the Jupyter notebook has to turn in his code to his professor.
 
+# User tasks
 Users should be able to:
-* Save the file
-* Download the file as
-* Print the file
-
-## Other Solutions
-
-The Jupyter Notebook currently has a top menu bar that allows you to save the file, download the file as, print the file, etc. 
-
-Display explanatory text should be displayed faster. 
-
-An indicator when the file has been saved similar to the Jupyter Notebook.
-
-Section off the different tools according to their category to make it easier for the user to find the button they want to use.
-
-## What users should be able to see or do
-
-* Easily identify what the icon actions do
-* When “New Notebook” command is selected, "Create New Notebook" popup appears
-
-## Visual Design
-
-### Layout
-
-Section the icon tools off according to their category using dividers like the ones around the dropdown menu for “Code”. **See detailed design mock up [here](https://github.com/jupyter/jupyterlab/issues/227#issuecomment-230566045).**
-
-Make the Kernel label on the top right of the notebook a dropdown menu where you can select to switch kernels.
-
-Include an indicator that the file is being saved on the toolbar. 
-
-Popup for creating a new notebook fades the background to dark grey. Popup appears in the center of the screen. Under
-"Create a new notebook", user can name their notebook and select kernel.
-
-Once top menu bar has been created for JupyterLab, include buttons that allow you to download the file as, print the file, etc.
-
-### Typography
-
-Typeface will stay consistent with current typeface on the Jupyter Notebook.
-
-### Colors
-
-Colors will stay consistent with current color theme.
-
-### Motion
-
-Speed of explanatory text should increase when hovering over icons.
 
-**Team IO: @faricacarroll @spoorthyv @charnpreetsingh185 @katiewhite360**
+* See the name of the notebook on the top menu bar
+* Change the name of the notebook (file browser menu, top menu)
+* Get a user interface tour (top menu)
+* Use notebook cell operations
+   * Clear output(s) (command palette)
+   * Convert to code (command palette, shortcut, toolbar)
+   * Convert to markdown (command palette, shortcut, toolbar)
+   * Convert to raw (command palette, shortcut, toolbar)
+   * Copy Cells(s) (command palette, shortcut, toolbar)
+   * Cut Cells(s) (command palette, shortcut, toolbar)
+   * Delete Cell(s) (command palette, shortcut, toolbar)
+   * Extend selection above (command palette, shortcut)
+   * Extend selection below (command palette, shortcut)
+   * Insert Cell Above (command palette, shortcut)
+   * Insert Cell Below (command palette, shortcut)
+   * Merge Selected Cell(s) (command palette, shortcut)
+   * Paste Cell(s) (command palette, shortcut, toolbar)
+   * Redo Cell Operation (command palette, shortcut)
+   * Run Cell(s) (command palette, shortcut)
+   * Run Cell(s) and Advance (command palette, toolbar, shortcut)
+   * Run Cell(s) and Insert (command palette, shortcut)
+   * Select Cell Above (command palette, shortcut)
+   * Select Cell Below (command palette, shortcut)
+   *  Split Cell (command palette, shortcut)
+   * Toggle Line Numbers (command palette, shortcut)
+   * Undo Cell Operation (command palette, shortcut)
+   * Redo Cell Operation (command palette)
+   * Select multiple cells at once (mouse, shortcut)
+   * Move cell(s) up and down (mouse)
+* Use notebook operations
+   * Clear All Outputs (command palette)
+   * Interrupt Kernel (command palette, shortcut, toolbar)
+   * Restart Kernel & Clear Outputs (command palette)
+   * Restart Kernel & Run All (command palette)
+   * Run All Cells (command palette)
+   * Switch Kernel (command palette, toolbar)
+   * To Command Mode (command palette, shortcut, mouse)
+   * To Edit Mode (command palette, shortcut, mouse)
+   * Toggle All Line Numbers (command palette)
+* See when the code is running in top right corner circle (toolbar)
+* See when the file has most recently been saved (toolbar)
+* See a reaction when an icon has been click (toolbar)
+* Include a top menu above the toolbar 
+* Make a Copy (top menu)
+* Print Preview (top menu)
+* Download file as (top menu)
+* Find and Replace (top menu)
+* Be able to open a keyboard shortcut specific for the notebook (command palette)
+
+# Visual design
+* Add sections to the icon tools
+* Replace icons with google’s material icons
+* Make the top right kernel label a dropdown
+* Include an indicator that the file is being saved on the toolbar
+* Additional commands will follow the style guidelines of the current command palette
+* When the mouse hovers versus clicks on an icon, there are separate indicators (colors) for each
+
+# Design questions
+* Should there be a keyboard shortcut specific for the notebook, continue using the command palette as the lists of shortcuts, or redesign the command palette functionality?