---
# System prepended metadata

title: Untitled

---

## 制作の背景と目的
### 制作の背景

オープンなドキュメント管理サービスがあまりなかった。
slackみたいに気になるプロジェクトにセルフアサインできて、
他のチームとも意見交換がもっとできた方がいいと思うので作りたい。

> [name=None] こんなのでいい？

### 制作の目的
制作の目的として、プロジェクトのゴールを記述します。

> [name=None] よくわかんない。「完成」とか？

### 制作の目標
制作において達成すべき目標を記述します。KGIやKPIがあればあわせて記述します。

> [name=None] よくわかんない。「完成」とか？

### システムの全体像 / 概念図
ここではサイトマップではなく、制作するサイトの全体像を図で示します。例えばCMSを導入する場合は、公開画面と管理画面が存在することが分かるように図で示します。

> [name=None] あとで図を作ります

## プロジェクトについて
### 作業スコープ（作業範囲）

- プロジェクト管理
- 要件定義書作成
- デザイン作成
- HTML/CSS/JavaScript実装
- Golang実装
- 本番サーバー環境構築
- テストサーバー環境構築
- ブラウザ検証

### プロジェクト体制
プロジェクト体制を図で示します。
関係する会社、部門、担当者、役割を明記します。


> [name=None] こんな表で良いですか


| 名前 | 担当 |
| -------- | -------- |
| れん     | Golangおよびバックエンド全体 |
| のーん |Nuxt.js フロントエンド全体 |
| わてり | Golang |


## サイト要件
### ターゲットユーザー
今回の制作物のターゲットとなるユーザーを明記します。

14~25の若年層エンジニア/デザイナー向け

### ターゲットOS/ブラウザ
動作保証するOSとブラウザを定義します。
OSごとにどのブラウザを担保するか表形式で明記すると分かりやすくなります。

MacOS - chrome safari firefox
Windows - chrome firefox


### サイトマップ
制作物のサイトマップを図で示します。
もしドキュメント内に収まらない場合は別添とします。

- トップ
    - ログイン
    - サインイン
- ダッシュボード
    - ドキュメント一覧
        - カテゴリーごと
        - 日付順
        - 全部
    - ドキュメント検索
        - タグ
        - 日付
        - 書いた人
    - ワークスペース切り替え
    - 新規ドキュメント作成
    
- 管理画面
    - 新規ワークスペース作成
    - 新規チーム作成
    - メンバー管理
    - ワークスペース削除
    - チーム削除
    - チーム設定
    - ワークスペース設定
    - ログアウト
    - 退会

## システム要件
### 機能要件
実装する機能を一覧で示すのが一般的です。

- ワークスペース管理
- チーム管理
    - パブリックチーム/プライベートチーム
- Markdownでの文書作成
    - リアルタイムプレビューのできるエディター
    - タグ機能
- コメント
- いいね

### 非機能要件
実装する機能以外の要件を定義します。
次の項目を観点として、それぞれ定義することをおすすめします。

（例）可用性
（例）性能・拡張性
（例）運用・保守性
（例）移行性
（例）セキュリティー

> [name=None] ここよくわかんないので助けてください

### インフラ要件
ドメインやSSLサーバー証明書、ネットワーク、サーバー環境について定義します。
項目例を列挙します。

（例）契約先のIDC、プラン
（例）サーバー、ネットワーク構成図

環境 : Heroku AWS-S3
ドメイン取得先、ドメイン名: 
SSL証明書取得先、種類:  Let's Encript

### 技術要件
開発言語や使用するフレームワークについても定義しておきます。

開発言語 : JavaScript HTML5 CSS3 Golang
フレームワーク : Nuxtjs
バージョン管理 : Git
データベース: 検討なう(NoSQLかSQLか)
その他: Docker/Docker-compose

## その他
### 用語の定義
プロジェクト独自で使われる言葉があれば、用語として定義し一覧化します。

| 用語 | 内容 |
| -------- | -------- |
| チーム     | slackでいうチャンネル。自分でアサインできる |
| ワークスペース     | チームが集まったもの。slackでのワークスペースと同じようなもの | 
