Skip to content

Minimum Viable Product Requirements

Jump to bottom
Tom Taylor edited this page Aug 15, 2016 · 3 revisions

See below for the full list of requirements (including the shoulds and coulds).

Mandatory requirements

Super Administrator

  • SPR-TEN-001: Able to CRUD tenancies
  • SPR-API-001: Able to enable/disable APIs / API plug-ins
  • SPR-API-002: Able to add new plug-in webservice APIs required for LP catalogue, third party integration
  • SPR-API-003: Able to remove added plug-in webservice APIs
  • SPR-QUO-005: Able to run usage reports on quote usage for tenancies
  • SPR-POL-001: Able to set and change file upload limits
  • SPR-POL-002: Able to define user creation options for tenancies
  • SPR-POL-003: Able to define system role creation options for tenancies

All users

  • ALL-LGN-003: Able to reset my password securely
  • ALL-PRO-001: Able to set and change my personal details
    • Name
    • e-mail
  • ALL-COL-001: Able to invite collaborators to projects I own (or have sufficient permissions to)
  • Fine grained permissions + giving users the ability to control that we consider this applies to system accounts
  • ALL-COL-002: Able to see all collaborators on a course/project
  • ALL-COL-003: Able to remove collaborators from a project I own (or have sufficient permissions to)
  • ALL-COL-009: Able to share guest access (for non-system users) for review on projects I own (or have sufficient permissions to)
  • ALL-COL-011: Able to link directly to a specific component within a course

Tenancy Admininstrator

  • ADM-TEN-002: Able to CRUD system roles from capabilities in the scope of a tenancy
  • ADM-TEN-003: Able to assign/unassign tenancy-scope system roles to users within the tenancy
  • ADM-TEN-005: Able to CRUD users within the tenancy
  • ADM-TEN-006: Able to view system logs (users actions) within the scope of a tenancy
  • ADM-TEN-007: Able to manage course/project ownership
  • ADM-TEN-019: Able to turn guest user access to the tenancy on/off (also applies to super admin)
  • ADM-TEN-024: Able to set the password policy

Content Creator

Look and feel

  • CCR-LF-001: Able to choose a standard theme from a range of options
  • CCR-LF-002: Able to choose a custom theme
  • CCR-LF-003: Able to modify basic theme colour settings
  • CCR-LF-004: Able to modify high-level padding and spacing settings
  • CCR-LF-005: Able to set standard font face for the course
  • CCR-LF-006: Able to set the standard font size for the course
  • CCR-LF-009: Able to choose background image for the entire course
  • CCR-LF-010: Able to choose background images for menus
  • CCR-LF-011: Able to choose background images for pages
  • CCR-LF-012: Able to choose background images for articles
  • CCR-LF-013: Able to insert a transparent placeholder which allows learners to see the background graphic TT: blank component??

Asset management

  • CCR-AMGMT-016: Able to upload themes
  • CCR-AMGMT-017: Able to change (re-upload) themes
  • CCR-AMGMT-019: Able to delete themes

Navigation

  • CCR-MEN-001: Able to choose a generic menu from a range of options (excludes multiple standard options)
  • CCR-MEN-003: Able to upload a custom menu

Data entry / editing

  • CCR-WOW-001: Able to build content quickly without advanced technical expertise
  • CCR-WOW-020: Able to immediately preview my changes via providing a link on the server on multiple devices

Learner support

  • CCR-LSUP-001: Able to add/remove file resources (not in Framework 1.0 release)

Overrides

  • CCR-OVR-001: Able to add a ZIP archive, which will be extracted as part of the publishing process and override core Adapt code files
  • CCR-OVR-002: Able to remove the ZIP archive

Developer

  • AUTH-DEV-001: Able to upload files to override core code (similar to: CCR-OVR-001 + 002)
  • AUTH-DEV-002: Able to test the effect of overrides in preview
  • AUTH-DEV-003: Able to turn debugging of the authoring tool on / off

Guest User

  • AUTH-GST-001: Able to enter the system without having to create a system account
  • AUTH-GST-002: Able to view projects which are visible to guest users
  • AUTH-GST-003: Able to view projects, which have been shared with the guest user's email address
  • AUTH-REV-008: Able to launch content in preview mode (moved from reviewer)

Non-mandatory requirements

Should

Super Administrator

  • SPR-TEN-002: Able to manage cross-tenancy user access (should as can do multiple user accounts)
  • SPR-POL-004: Able to define plug-in management options for tenancies
  • SPR-PLG-007: Able to run a system health-check

All users

  • ALL-WOW-004: Able to have context sensitive help available throughout the system TT: partly -- have input-field-specific help
  • ALL-ROL-001: Able to hold multiple roles across multiple tenancies
  • ALL-ROL-005: Able to see a history of projects worked on:
    • Most recently used, e.g. recent docs in Word.
    • History covered by system logs -> visible to the user?
  • ALL-PRO-004: Able to set the timezone (include time formatting to enable US/UK spelling)
  • ALL-COL-004: Able to determine the editing rights for collaborators of courses/projects I own (or have sufficient permissions to)
  • ALL-COL-010: Able to invite collaborators who don't already have system accounts

Tenancy Administrator

  • ADM-TEN-010: Able to see a usage dashboard against quotas (users, courses/projects, file storage, bandwidth used etc).
  • ADM-TEN-021: Able to determine whether collaboration invites can be sent to system users only or also to external users

Content Creator

Course creation / management

TT: assumption that categories === tags

  • CCR-CRS-001: Able to CRUD categories
  • CCR-CRS-002: Able to CRUD subcategories at any level
  • CCR-CRS-004: Able to assign courses to categories
  • CCR-CRS-005: Able to remove courses from categories
  • CCR-CRS-007: Able to set the status and workflow stage
  • CCR-CRS-019: Able to filter and search for courses/projects using search terms

Data entry / editing

  • CCR-WOW-012: Able to resize images (ties in with 013 and 014)
  • CCR-WOW-013: Able to crop images
  • CCR-WOW-014: Able to compress images
  • CCR-WOW-022: Able to lock a content item to prevent further changes (audit / page level locking)

Assessment

  • CCR-ASSM-013: Able to group questions into banks around subject areas
  • CCR-ASSM-014: Able to configure how many questions will be displayed per bank
  • CCR-ASSM-015: Able to configure mandatory questions for each bank
  • CCR-ASSM-016: Able to randomise the display order of questions
  • CCR-ASSM-017: Able to randomise the order and choice of questions
  • CCR-ASSM-018: Able to signpost to the learner which subject areas they need to revisit as part of the post assessment feedback

System validation

  • CCR-SVAL-002: Able to run a system requirements report (e.g. browser spec) for the course based on the metadata for the components and plug-ins used

Publishing

  • CCR-PUB-003: Able to publish my project as a Tin Can package

Developer

  • AUTH-DEV-007: Able to see a technical log of course actions in preview mode (including tracking)

Reviewer

  • AUTH-REV-001: Able to see a complete list of issues and comments
  • AUTH-REV-002: Able to search and filter list of changes/comments
  • AUTH-REV-003: Able to add additional detail to a comment / change
  • AUTH-REV-004: Able to remove a comment change
  • AUTH-REV-005: Able to change the status of a comment / change
  • AUTH-REV-006: Able to navigate to the place where the comment / change was made
  • AUTH-REV-007: Able to export all comments / changes to a printable format
  • AUTH-REV-009: Able to raise issues / make comments while previewing the course
  • AUTH-REV-010: Able to view comments and tracked changes in context while previewing the course
  • AUTH-REV-011: Able to make tracked changes in the content
  • AUTH-REV-012: Able to see all the textual content in sequence (not in published form)

Could

Super Administrator

  • SPR-QUO-001: Able to set number of users quota for tenancies
  • SPR-QUO-003: Able to set file storage limit quotas for tenancies
  • SPR-BCK-001: Able to configure automatic system backup
  • SPR-PLG-008: Able to integrate for user authentication via a webservice API

All users

  • ALL-WOW-003: Able to use wizards to help guide me through the system
  • ALL-ROL-003: Able to see the status for each project I work on in the dashboard
  • ALL-ROL-004: Able to get an overview of activity and tasks on courses/projects I work on
  • ALL-PRO-003: Able to set and change an avatar image
  • ALL-COL-005: Able to leave a course/project

Tenancy Administrator

  • ADM-TEN-004: Able to set and change default values for courses/projects
  • ADM-TEN-008: Able to freeze/lock/unlock a courses/projects to prevent/enable changes
  • ADM-TEN-009: Able to apply policy values for the tenancy within the range determined by the super administrator
  • ADM-TEN-012: Able to choose which installed component plug-ins to make available to the tenancy users
  • ADM-TEN-013: Able to choose which installed extension plug-ins to make available to the tenancy users
  • ADM-TEN-014: Able to choose which installed publishing options to make available to the tenancy users
  • ADM-TEN-022: Able to configure plug-ins for the scope of the tenancy and per project
  • ADM-TEN-025: Able to set the account expiry policy

Content Creator

Asset management

  • CCR-AMGMT-018: Able to see which courses would need to be republished for theme changes to be reflected
  • CCR-AMGMT-023: Able to report on usage of themes

Course creation / management

  • CCR-CRS-011: Able to show/hide a course
  • CCR-CRS-012: Able to lock a course (i.e. allow/prevent pro-active access for non-collaborators)

Course structure

  • CCR-CSTR-028: Able to move an article across pages

Data entry / editing

  • CCR-WOW-002: Able to see only the necessary data entry fields by default
  • CCR-WOW-006: Able to resume editing a course from the same point (component; block) that I was a when I last saved and closed it
  • CCR-WOW-007: Able to edit inline whilst previewing output
  • CCR-WOW-018: Able to embed Captivate files (separate component)

Learner support

  • CCR-LSUP-002: Able to add/remove the glossary of terms
  • CCR-LSUP-003: Able to CRUD glossary terms and explanations
  • CCR-LSUP-004: Able to include/turn off the search feature (not in Framework 1.0 release)

Assessment

  • CCR-ASSM-007: Able to determine assessment prerequisites / entry criteria (e.g. completion of other materials in the course)

System validation

  • CCR-SVAL-001: Able to run a system validation over my course/project content files and see a log of any system readable errors (e.g. JSON checker)
  • CCR-SVAL-003: Able to generate a diagnostic report of my project (length, level of interactions etc)

####Translation

  • CCR-TRAN-001: Able to export all language content in a packaged format suitable for translation agencies to work with
  • CCR-TRAN-003: Able to import a translated language content package as a new course

Developer

  • AUTH-DEV-005: Able to embed HTML / JavaScript in suitable places (could do better via bespoke?)

Authoring Tool Home | Framework Home | Technical Discussion Forum | Back to Top

adapt logo

For End Users

Getting Started

Authoring courses

Plug-ins

For Developers

Developing Plug-ins

Process

Resources

Clone this wiki locally