coralnet icon indicating copy to clipboard operation
coralnet copied to clipboard

Guides/tutorials in Help portal

Open StephenChan opened this issue 5 years ago • 1 comments

Split off from #127, which will be designated for Help portal basics.

Worth mentioning here too: I don't think we need to repeat what the "?" help buttons say. Those more or less serve their purpose to provide details about a specific page on the site. But people could still use help to figure out what sequence they should do things in to get their work done. Basically, teach at a high level how people can get their work done on CoralNet.

Guides/tutorials could include the following:

  • How to upload, how to annotate, how the deep learning backend works, etc.: similar to our old video tutorials.
  • Guides/tutorials describing full use cases and workflows.
    • Example 1: Create labelset, upload images, annotate some, let backend work, annotate the rest with annotation tool + machine suggestions, export annotations to CSV.
    • Example 2: Create labelset, upload images, upload some annotations from CPC, let backend work, apply Alleviate at 80%, export annotations to CPC, finish annotating in CPCe. (Living Oceans Foundation workflow)

Possible formats: video, or a written guide with screenshots. The main advantage of written guides is that they're much easier to update later compared to a video. Perhaps we can default to written guides, and consider doing videos for particularly important topics.

StephenChan avatar Aug 15 '19 19:08 StephenChan

Got one tutorial written up - CPC import/export: https://coralnet.ucsd.edu/pages/help/tutorials/cpce/

StephenChan avatar Mar 04 '21 22:03 StephenChan