Project Title

Table of Contents

• Project Title
  • Table of Contents
  • Beginners Guide
  • User story
  • User flows
  • Project Timeline
  • Appendix and FAQ

Beginners Guide

If you are a total beginner to this, start here!

1. Visit hackmd.io
2. Click "Sign in"
3. Choose a way to sign in
4. Start writing note!

User story

Feature: Guess the word

  # The first example has two steps
  Scenario: Maker starts a game
    When the Maker starts a game
    Then the Maker waits for a Breaker to join

  # The second example has three steps
  Scenario: Breaker joins a game
    Given the Maker has started a game with the word "silky"
    When the Breaker joins the Maker's game
    Then the Breaker must guess a word with 5 characters

I choose a lazy person to do a hard job. Because a lazy person will find an easy way to do it. Bill Gates

Feature: Shopping Cart
  As a Shopper
  I want to put items in my shopping cart
  Because I want to manage items before I check out

  Scenario: User adds item to cart
    Given I'm a logged-in User
    When I go to the Item page
    And I click "Add item to cart"
    Then the quantity of items in my cart should go up
    And my subtotal should increment
    And the warehouse inventory should decrement

Read more about Gherkin here: https://docs.cucumber.io/gherkin/reference/

User flows

Read more about sequence-diagrams here: http://bramp.github.io/js-sequence-diagrams/

Project Timeline

Read more about mermaid here: http://mermaid-js.github.io/mermaid/

Appendix and FAQ

Find this document incomplete? Leave a comment!

tags: Templates Documentation