---
title: 'Project documentation template'
disqus: hackmd
---

Project Title
===
![downloads](https://img.shields.io/github/downloads/atom/atom/total.svg)
![build](https://img.shields.io/appveyor/ci/:user/:repo.svg)
![chat](https://img.shields.io/discord/:serverId.svg)

## Table of Contents

[TOC]

## 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
---

```gherkin=
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. [name=Bill Gates]


```gherkin=
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
---
```sequence
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
Note left of Alice: Alice responds
Alice->Bob: Where have you been?
```

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

Project Timeline
---
```mermaid
gantt
    title A Gantt Diagram

    section Section
    A task           :a1, 2014-01-01, 30d
    Another task     :after a1  , 20d
    section Another
    Task in sec      :2014-01-12  , 12d
    anther task      : 24d
```

> Read more about mermaid here: http://knsv.github.io/mermaid/

## Appendix and FAQ

:::info
**Find this document incomplete?** Leave a comment!
:::

###### tags: `Templates` `Documentation`


---

## Page Navigation

- Canonical URL: https://demo.growi.org/Sandbox/HachMD
- Permalink: https://demo.growi.org/5d4a553a4dc19b0044efe4ba
- Parent: [Sandbox](/5a6eee6b6e451000259030c4.md)
- Children: 0 total
- Total descendants: 0
- Siblings: 27 total
  - [Bootstrap3](/5f6d466c2d73df0048881f75.md)
  - [Bootstrap4](/5a8b15576cf1e900242e0f43.md)
  - [Diagrams](/5ed46e05df07e700484389f1.md)
  - [GUI for Table](/5bd2f39bf515a1003efcde54.md)
  - [Math](/5ed46e05df07e700484389f4.md)
  - [Playground](/63d703bf36fd83995cdaae2d.md)
  - [Restricted page](/59378296a8600d00183d7ab4.md)
  - [SharedPage1](/5f31449b9c39330048375177.md)
  - [Untitled-1](/66cbe4d99bcdc42f9dc40010.md)
  - [Youtube動画を中央表示](/60a7f95f2d5aa40049c30154.md)
  - [__template](/637356833e38e2684997df23.md)
  - [_template](/637356663e38e2684997dca4.md)
  - [aannn](/645a3b4e4be73a5db39b9eb4.md)
  - [crowi と GrowiのMarkdown互換性テスト](/5acc7a569b81eb0024a7b2cc.md)
  - [diagrams.net 数式組版](/63189b3c5a4a0b3a50d595d4.md)
  - [emoji](/60a7f8cf2d5aa40049c30077.md)
  - [growi-plugin-attachment-refs](/60a888a95e88b400492d82fc.md)
  - [highlightjs-latex](/61f4eb41885ab8fb50376f68.md)
  - [plantuml_test](/5a8bec226cf1e900242e0f7b.md)
  - [sequence-diag-xss](/5ad69c33087ab40027fe598f.md)
  - [toc_test](/67822a741b385d2d08b14644.md)
  - [スタッフロール](/5d7a3cc84dc19b0044efe6c4.md)
  - [ファイルアップロードテスト2](/592ff9847f616a0019f77e93.md)
  - [リダイレクトテスト_to](/594bc54f149d740018d73870.md)
  - [新しいNotFoundページテスト](/625fd656760a41736ba1a767.md)
  - [閲覧制限ページ通知テスト](/5ef2ae4bdad9690048f1973e.md)
  - [階層テスト1](/61711bde7c95df220dc2f773.md)
- Last updated: 2019-08-07T04:37:13.349Z by admin1
- Full page listing (all children regardless of count): https://demo.growi.org/_api/v3/page-listing/children?id=5d4a553a4dc19b0044efe4ba