---
# System prepended metadata

title: Project documentation template
tags: [Templates, Documentation]

---

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

StudioMass ホームページ運用
===
![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)

## 目次

[TOC]

## はじめに

studioMass のホームページを複数人で運用するにあたって、取りまとめの手間をなるべく減らすため下記方針をとる。

* 寄稿者自身が編集し投稿する。
* 複数人による記事は各人が編集した後、管理者が調整の上投稿する。

## アカウント
### アカウント機能
アカウント機能はWP-Membersプラグインを使用して実装する。
クイックスタート：https://geeksgrowth.com/how-to-use-wp-members/
詳細マニュアル：https://rocketgeek.com/plugins/wp-members/docs/

### アカウント作成方法

1. ログインページにアクセスする。https://studiomassmastering.com/partner-login/
2. 「はじめての方はこちら」から登録画面に進む。
3. メールアドレス及びパスワード、アイコン画像(メンバーページで使用)を選択して登録。
4. メールが受信できれば完了。


## メンバーページ

### 運用方針
* メンバーページは各人が編集し投稿、修正する。
* サービス価格や内容はサービスページの内容と一致させる。

### 実装方法
* Membersカテゴリーのカテゴリーページとして準備する。
* サブカテゴリーは"Engineer"と"Creator"

### メンバーページの登録・編集方法




## アピアランス
### テーマ
ブログ特化型の有料テーマである「Jin」を使用する。
### カラースキーム
* 基本色は黄色(#ffcd44)とする。
* その他の色については、下記のカラースキームに則って設定する。https://www.colorhexa.com/ffcd44
* 明度の変更は自由。彩度の変更は基本的にNG。


## 見積・売上管理
### 運用方針
複数人が別々の場所から顧客対応をすることを前提として以下の条件を満たすようにする。
* インターネット経由でどこからでもアクセス可能であること。
* 全ての売上を管理し検索可能であること。
* なるべく人の手を介さず自動的に運用可能であること。
### 実装方法
サブドメイン：www.finance.studiomassmastering.com にて[billvector](https://billvektor.com)テーマを用いる。
安全性確保のためWP-Membersアドインで全ページにアクセス制限を課す。
アカウント情報を共有するため、メインサイトと同じデータベース内にサブドメインサイトを構築し、アカウントテーブルを共有する。構築方法は[ココ](https://mirai-creators.com/3755/)を参照。サブドメインのDNSはメインドメインの管理設定より実施する。
### 見積書自動作成
メインサイトから顧客がフォーム入力するとサブドメインサイトにて顧客情報及び見積書などが投稿されるようにする。

### パートナーへの支払い管理
billvector提供の[給与明細システム](https://billvektor.com/add-on/billvektor-salary/)プラグインを利用する。

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`
