This page gathers use cases around the topics workflows and visibility of content. As such it reflects discussions around the submission and publication process as well as other processes.
Use cases
The following use cases describe what can be done with the site. Each use case lists a couple of features:
Precondition: | What precondition must be met? Which use cases need to be completed? |
---|---|
Availability: | To whom is this use case available? |
Objects: | What objects are available in this use case? |
Duration: | How much time may a use case take? |
Notification: | Who is notified? |
Submitting and publication
Creating proposal
Creating a proposal is the activity by which someone starts editing a proposal. Basically it is creating a new page containing the proposal.
Precondition: | None |
---|---|
Availability: | Contributors |
Objects: | New page in proposal section of the submission folder |
Duration: | Single action |
Notification: | Responsibles |
Editing proposal
After a proposal has been created it can be edited by the respective contributor.
Precondition: | Creating proposal, Deciding proposal with rejection |
---|---|
Availability: | |
Objects: | Initial proposals created by this contributor |
Duration: | May be repeated zero or more times until proposal is decided upon |
Notification: |
|
Submitting proposal
After a proposal has been created and edited by the contributor until satisfaction it can be submitted for review.
Precondition: | Editing proposal, proposal submitted at most twice before |
---|---|
Availability: | Contributors |
Objects: | Initial proposals created by this contributor |
Duration: | Single action |
Notification: | Responsibles |
Reviewing proposal
Responsibles review a submitted proposal. They add comments containing
- suggestions on what to add or drop
- suggestions on possible decisions
Precondition: | Submitting proposal |
---|---|
Availability: | Responsibles |
Objects: | Comments for all proposals which have been submitted |
Duration: | May be repeated at least once within 2 weeks |
Notification: | Contributor of the proposal |
Deciding proposal
After reviewing a submitted proposal responsibles decide on how to proceed. These are the options:
encourage contributor to write an article
The contributor is encouraged to write an article based on the proposal and the review results.
reject proposal
The proposal is rejected. The contributor may continue to edit the proposal.
Precondition: | Reviewing proposal |
---|---|
Availability: | Responsibles |
Objects: | Submitted proposals |
Duration: | Single action |
Notification: | Contributor of the proposal, responsibles |
Creating article
Creating a article is the activity by which someone starts editing a article. Basically it is creating a new page containing the article. This may be the result of a proposal or the article may be created from scratch.
Precondition: | None, Deciding article with encouraging |
---|---|
Availability: | Contributors |
Objects: | New page in the article section of the submission folder |
Duration: | Single action |
Notification: | Responsibles |
Editing article
After a article has been created it can be edited by the respective contributor.
Precondition: | |
---|---|
Availability: | |
Objects: | Articles created by this contributor |
Duration: | May be repeated zero or more times until article is decided upon |
Notification: |
|
Submitting article
After a article has been created and edited by the contributor until satisfaction it can be submitted for review. When submitting the article the contributor must decided whether the article is subject to:
binary rating
When the article is published it is done without a precise rating from the responsibles. Only optimal articles can be published this way.
differentiated rating
When the article is decided upon the responsibles give a differentiated rating for the article telling readers where the article is great and where it could be improved. Articles which are not optimal can be published this way.
Precondition: | Editing article |
---|---|
Availability: | Contributors |
Objects: | Initial articles created by this contributor |
Duration: | Single action |
Notification: | Responsibles |
Reviewing article
Responsibles review a submitted article. They add comments containing
- suggestions on improvements
- in case of binary rating: suggestions on possible decisions
- in case of differentiated rating: ratings on various aspects of the article
- deadlines until which the improvements are to be made
Precondition: | Submitting article |
---|---|
Availability: | Responsibles |
Objects: | Comments for all articles which have been submitted |
Duration: | May be repeated at least once within 4 weeks |
Notification: | Contributor of the article |
Deciding article
After reviewing a submitted article responsibles decide on how to proceed. These are the options:
publish article
The article is published together with the results of the review. If the article is in differentiated rating mode the differentiated rating is included here. If there was a proposal before the article the results of the review of the proposal are also published.
reject article
The article is rejected.
Precondition: | Reviewing article |
---|---|
Availability: | Responsibles |
Objects: | Submitted articles |
Duration: | Single action |
Notification: | Contributor of the article, responsibles |
Using the journal
Reading published articles
Reading published articles is what readers of the journal do at the minimum.
Precondition: | Deciding article with publishing |
---|---|
Availability: | Readers |
Objects: | Published articles |
Duration: | Forever |
Notification: | None |
Commenting published articles
Readers may comment published articles when they are logged in.
Precondition: | Deciding article with publishing |
---|---|
Availability: | Members |
Objects: | Comments on published articles |
Duration: | Forever |
Notification: | Contributor |
Rating published articles
Readers may rate published articles when they are logged in.
Precondition: | Deciding article with publishing |
---|---|
Availability: | Members |
Objects: | Ratings on published articles |
Duration: | Forever |
Notification: | Contributor |
User management
Becoming a member
If a reader wants to use the options only members have the reader must create an account which automatically gets the member role.
Precondition: | None |
---|---|
Availability: | Readers |
Objects: | New account |
Duration: | Single action |
Notification: | None |
Becoming a contributor
If a member wants to become a contributor the member must designate herself to contributor status.
Precondition: | Becoming a member |
---|---|
Availability: | Members |
Objects: | Contributor flag in account |
Duration: | Single action |
Notification: | Responsibles |
Proposing an additional responsible
If a responsible thinks that a third person should also be a responsible this can be proposed.
Precondition: | None |
---|---|
Availability: | Responsibles |
Objects: | New page in responsible proposal folder |
Duration: | Single action |
Notification: | Responsibles |
Discussing an additional responsible
After an additional responsible is proposed the inclusion of the proposed person is discussed.
Precondition: | Proposing an additional responsible |
---|---|
Availability: | Responsibles |
Objects: | Respective page in responsible proposal folder |
Duration: | Until decision can be made |
Notification: | Responsibles |
Deciding additional responsible
After an additional responsible is discussed it is decided whether to include the proposed person. These are the options:
add as a responsible
The account of the person gets the responsible role.
do not add as a responsible
Precondition: | Proposing an additional responsible |
---|---|
Availability: | Responsibles |
Objects: | Respective page in responsible proposal folder |
Duration: | Until decision can be made |
Notification: | Responsibles |
Glossary
Roles
- Contributor
- A logged in user who may add content which may end up in an article.
- Reader
- A user which is not logged in to the site. Any web user can be a reader.
- Responsibles
- Persons who are responsible for the journal.
States
- Published
- A state of an content item in which it can be read by readers.
- Submitted
- A state of a proposal or article where it should be reviewed by the responsibles.
Objects
- Account
- The facility used by Plone by which a user is authenticated and identified. Users who have an account can login to this account.
- Article
- An article is a page with some content according to the mission statement of the journal. Articles are the things the journal is all about.
- Comment
- A comment is a note attached to some other content saying something about this content.
- Proposal
- A proposal is some content which proposes an idea for an article. It may be very brief or more elaborated.
- Rating
- A rating is a value from a fixed range applied to some rating category. Multiple ratings can be combined.
- Responsible proposal folder
- A special folder where proposals for new responsibles can be put to.
- Submission folder
- A special folder on the site where content can be put for review. The folder has a section for proposals and a section for articles._