--- 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] ## Overview We have a SaaS platform built in C# [located here](https://gitlab.com/fr8/) on gitlab [https://gitlab.com/fr8/]. 1. Seal: This is the main repo, it has a mongodb 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? Gianco->Bob: hi ``` > Read more about sequence-diagrams here: http://bramp.github.io/js-sequence-diagrams/ Project Timeline --- ```mermaid gantt title A Gantt Diagram section 活动管理 启动准备: done, des1, 04-13, 04-18 需求准备及开发: done, des2, 04-19,05-11 修改调整: done, des3, 05-12, 06-11 审批流pre-check: done, des4, 06-11, 06-23 sign-off meeting: des5, after des4, 06-24 测试Round 1: des6, after des5, 7d 测试Round 2: des7, after des6, 7d 测试Round 3: des8, after des7, 7d 测试Round 4: des9, after des8, 7d 上线: des10, after des9, 1d section 付款管理 修改调整 :active, 06-17 , 14d ``` > Read more about mermaid here: http://mermaid-js.github.io/mermaid/ ## Appendix and FAQ :::info **Find this document incomplete?** Leave a comment! ::: ###### tags: `Templates` `Documentation`