Editing Use case (section)

== Examples ==

Below is a sample use case written with a slightly modified version of the Cockburn-style template. Note that there are no buttons, controls, forms, or any other UI elements and operations in the basic use case description, where only user goals, subgoals, or intentions are expressed in every step of the basic flow or extensions. This practice makes the requirement specification clearer and maximizes the flexibility of the design and implementation.

[[File:Edit an article.svg|center]]

'''Use Case''': Edit an article

'''Primary Actor''': Member ''(Registered User)''

'''Scope''': a [[Wiki]] system

'''Level''': ! ''(User goal or sea level)''

'''Brief''': ''(equivalent to a [[user story]] or an epic)''

: The member edits any part (the entire article or just a section) of an article they are reading. Preview and changes comparison are allowed during the editing.

'''Stakeholders'''

...

'''Postconditions'''

: '''Minimal Guarantees''':
: '''Success Guarantees''':
:* The article is saved and an updated view is shown.
:* An edit record for the article is created by the system, so watchers of the article can be informed of the update later.

'''Preconditions''':

: The article with editing enabled is presented to the member.

'''Triggers''':

: The member invokes an edit request (for the full article or just one section) on the article.

'''Basic flow''':

# The system provides a new editor area/box filled with all the article's relevant content with an informative edit summary for the member to edit. If the member just wants to edit a section of the report, only the original content of the section is shown, with the section title automatically filled out in the edit summary.
# The member modifies the article's content until the member is satisfied.
# The member fills out the edit summary, tells the system if they want to watch this article, and submits the edit.
# The system saves the article, logs the edit event, and finishes any necessary post-processing.
# The system presents the updated view of the article to the member.

'''Extensions''':

2–3.

: a. Show preview:
:# The member selects ''Show preview'' which submits the modified content.
:# The system reruns step 1 with the addition of the rendered updated content for preview, and informs the member that his/her edits have not been saved yet, then continues.
: b. Show changes:
:# The member selects ''Show changes'' which submits the modified content.
:# The system reruns step 1 with the addition of showing the results of comparing the differences between the current edits by the member and the most recent saved version of the article, then continues.
: c. Cancel the edit:
:# The member selects ''Cancel''.
:# The system discards any change the member has made, then goes to step 5.

4a. Timeout:

...