Requirements Doc for Component Sharing in TIG 20019 (Code due December 31, 2021)

CCALI / a2jauthor

CALI A2JAuthor document automation authoring and viewing platform

https://www.a2jauthor.org

Other

4 stars 1 forks source link

Requirements Doc for Component Sharing in TIG 20019 (Code due December 31, 2021) #112

Open JessicaFrank opened 3 years ago

JessicaFrank commented 3 years ago

This issue is for planning and scoping the sharing of questions and pages amongst users in the TIG 20019 grant. Feel free to add/edit this issue with ideas. When ideas/brainstorms have solidified into distinct tasks, we'll break them off into separate issues.

"As an end user, I should be able to..." (Not sure this section is applicable here because it should all be author side work)

"As an author, I should be able to..."

[ ] select which questions and/or steps I want to duplicate in an interview and move them to another interview
[ ] choose from other interviews in a repository of shared interviews available to all authors
[ ] share all the components of a question, including variables, fields, text, labels, and logic
[ ] share templates with another interview
[ ] know that conflicts between versions will be handled

tobiasnteireho commented 3 years ago

"As an author, I should be able

[ ] fork a module
[ ] view all available public modules
[ ] view descriptions of modules including purpose and last update
[ ] view which interviews use which modules
[ ] view author and org of a module
[ ] view required inputs and expected outputs of a module
[ ] view all modules created by self
[ ] view all modules created by specific author
[ ] search and filter modules
[ ] sort modules

tobiasnteireho commented 3 years ago

"As an author, I should be able

[ ] view module fork tree

JessicaFrank commented 3 years ago

Code due December 31, 2021 Roll out to production by June 30, 2022

mikemitchel commented 3 years ago

Question around UX of the copying/sharing - @tobiasnteireho User stories above are talking more towards the ability to have a repository of partial Guides/Interviews as module building blocks, which is an idea I like, but feel like it might fall into a future feature interface.

Initially @JessicaFrank I was thinking we would require an Author to select a current source Guide and check all the parts of it they want to copy and then select a target Guide to copy those items into, and likely selecting 'destrucive' or 'non-destructive' copy style and/or offering a conflict resolution step to the copy.

Something similar to this (from https://github.com/mui-org/material-ui/issues/20259):

checkbox tree

Thoughts?