impactoss / impactoss-client

IMPACT OSS - client-side application
https://demo.impactoss.org
Other
4 stars 6 forks source link

Create quick start guide brochure #461

Closed tmfrnz closed 5 years ago

tmfrnz commented 6 years ago

Quick start guide/brochure with step-by-step instructions both as eBook and dedicated PDF brochure.

tmfrnz commented 6 years ago

Rather than “how-to-videos”, we would like to have a flow -chart or step–by–step instructions in text form.  In our specifications we had requested a brochure (i.e. a quick start guide) on how to use the tool.

tmfrnz commented 6 years ago

at the minimum we would like for a flow -chart or step–by–step instructions in text form in line with our specifications for a brochure (i.e. a quick start guide) on how to use the tool.

tmfrnz commented 6 years ago

I propose the following content outline

Introduction

Features

Brief introduction into IMPACT OSS features

Components

Brief introduction of the different components of IMPACT OSS

  1. Overview & categories
  2. Recommendations
  3. Implementation plan / actions
  4. Progress indicators (Admin users only)
  5. SDG targets (optional)
  6. Search
  7. Pages
  8. Users (Admin users only)

Admin quick start guide

Common use cases for site administrators

Create implementation plan

Create an implementation plan in 4 steps

  1. Enter recommendations a. single b. batch import
  2. Cluster, categorise and publish recommendations a. single b. batch edit
  3. Enter actions and indicators a. single b. batch import
  4. Assign actions to recommendations and publish actions a. single b. batch edit

Monitor implementation plan

Options for viewing the implementation plan

  1. Group actions
  2. Filter actions
  3. Sort actions
  4. Change view mode

Manage and promote users

How to manage and promote users

  1. Invite users to register
  2. Promote users
  3. Inform users

Further information

User roles

Overview of user roles

  1. Visitors
  2. Guests
  3. Contributors
  4. Managers
  5. Administrators