baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz / ucmitz ドキュメント作成ガイドライン

ucmitz ドキュメント作成ガイドライン

ucmitz のドキュメント作成にご協力頂きありがとうございます。これらのドキュメントは、GitHub.io で作成されています。

baserproject.github.io

 

ドキュメントの作成、編集方法

ドキュメントを作成したり編集したりする場合は2つの方法があります。

1. ローカルで編集

GitHub の baserproject.github.io よりレポジトリをクローンし、master ブランチで編集します。
GitHubにプッシュすると1分以内程度でドキュメントに反映されます。

レイアウトなどのデザインの調整をしたい場合は、dockerを立ち上げてから localhost:4000 にアクセスすると表示が確認できます。

docker-compose up

2. GitHub で編集

ドキュメント左上の「Githubでこのページを編集」をクリックすると、GitHub上の該当ページに移動します。右上の鉛筆マークをクリックすると編集モードに切り替わりますのでそこで編集します。
新しくファイルを追加する場合は、GitHub上でフォルダに移動し、右上の「Add file」をクリックします。

 

ファイル、フォルダの命名規則

英数字のスネークケース(アンダースコア区切り)とします。

例)user_groups.md

 

ファイルの配置

basic

開発方針などプロジェクトにおける基本となるドキュメントを配置します。

preparation

開発の準備に関わるドキュメントを配置します。

specification

設計書を配置します。

regulation

規定となるドキュメントを配置します。

development

開発に直接関係するドキュメントを配置します。

test

ユニットテストなどテストに関するドキュメントを配置します。

svg

PlantUMLなどで作成した SVGファイルを配置します。

etc

上記以外、その他のファイルを配置します。

 

図の作成

ユースケース図、ドメインモデル図、クラス図などの図の作成には、PlantUML を利用します。

PlantUMLの利用方法

 

設計書の構成

適度なボリュームの機能単位ごとに設計書を準備します。各設計書については次の章立てを基本として作成します。

概要

機能の概要について簡潔に記載します。

機能

対象物が持つ各機能についての説明を記載します。

ucmitzにおける仕様変更 

baserCMS4から ucmitzにおいて仕様変更がある場合は記載します。

ユースケース図

対象機能単位に対してのユースケース図をPlantUMLにて作成します。

ドメインモデル図

対象機能単位に対してのドメインモデル図をPlantUMLにて作成します。

クラス図

対象機能単位に対してのクラス図をPlantUMLにて作成します。

シーケンス図、アクティビティ図

処理の流れが複雑な場合、シーケンス図やアクティビティ図をPlantUMLにて作成します。