You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.
One of two "elephant in the room" issues relating to docs. This one deals with docs that users will want to read, wheras #17 deals with docs for developers. Users will need some documentation for Elsa 2.0. We are going to need to decide how much we are planning on preparing, and start scheduling the work to write it.
Here are some ideas of docs which users might want to read. We could use this as a starting-point for discussion, and it's almost certainly not complete:
Conceptual overviews
Introduction to each pre-created activity
What does it do?
What are its configuration parameters?
Does it expect any specific inputs?
What are its outputs?
How-to guides for the Dashboard & Designer UIs
Acceptance criteria
Presuming we treat this issue as a spike, then the team should have worked-up and agreed upon a list of user documentation topics which we plan to provide for Elsa 2.0.
In that case, further issues should be created and scheduled so that each of those may be worked-upon.
The text was updated successfully, but these errors were encountered:
One of two "elephant in the room" issues relating to docs. This one deals with docs that users will want to read, wheras #17 deals with docs for developers. Users will need some documentation for Elsa 2.0. We are going to need to decide how much we are planning on preparing, and start scheduling the work to write it.
It might be best to treat this particular issue as a spike, with the intended outcome of analysis & agreement. That way this issue doesn't inflate like a balloon and become a never-ending "Do all the work!" issue. In that case, the outcome of this will be to create a series of follow-up issues to write specific, agreed-upon pieces of documentation.
Here are some ideas of docs which users might want to read. We could use this as a starting-point for discussion, and it's almost certainly not complete:
Acceptance criteria
Presuming we treat this issue as a spike, then the team should have worked-up and agreed upon a list of user documentation topics which we plan to provide for Elsa 2.0.
In that case, further issues should be created and scheduled so that each of those may be worked-upon.
The text was updated successfully, but these errors were encountered: