Skip to content

[UserStory] ReadMe updates from a User perspective. #117

@elmattes

Description

@elmattes

User Story

Essential components

  • Title describes the story
  • Stakeholder type is identified
  • Outcome is described
  • Rationale is explicit
  • Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a user
I want I want my landing on the GitHub repository page with README displayed to tell me how to get and use the product
so that I can use the product and do so appropriately.

Acceptance Criteria

Change ReadMe to give it more clarity for brand new and returning users to utilize and run the project.
Specific changes for the user:

  1. The project website, along with introductory text, appears at the top of ReadMe after the project overview.
  2. BlueJ user instructions appear in the user-oriented website page
  3. Command line user instructions no longer appear in the repository-level README. (The text surrounding the webpage link at the top of the page provides adequate context to make it clear that information appears on the webpage.)

Supporting Information

All user-relevant information should appear on the project's "website" page.

Dependencies

Dependents

#113

Metadata

Metadata

Assignees

Labels

E: 2Effort: 2 Story-PointsS: SignificantSeverity: Significant - in the mainline plandocumentationImprovements or additions to documentationuser storyUser Story

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions