https://github.com/dai1678/product_specification_template
あなたのプロダクトの機能仕様書を管理・公開するためのリポジトリです。
https://github.com/dai1678/product_specification_template
deno documentation github-actions openai textlint
Last synced: about 2 months ago
JSON representation
あなたのプロダクトの機能仕様書を管理・公開するためのリポジトリです。
- Host: GitHub
- URL: https://github.com/dai1678/product_specification_template
- Owner: Dai1678
- Created: 2024-11-03T01:08:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T12:23:26.000Z (over 1 year ago)
- Last Synced: 2025-02-26T07:16:28.743Z (over 1 year ago)
- Topics: deno, documentation, github-actions, openai, textlint
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# プロダクト機能仕様書 / Product Feature Specification
あなたのプロダクトの機能仕様書を管理・公開するためのリポジトリです。
This repository is for managing and publishing the feature specifications of your product.
---
## このリポジトリで管理するもの / Items Managed in This Repository
- [/docs](./docs): プロダクトの機能仕様書を管理するディレクトリ
Directory for managing product feature specifications
## セットアップ / Setup
### テンプレートリポジトリからリポジトリを作成 / Create a repository from the template repository
[テンプレートリポジトリ](https://github.com/Dai1678/product_specification_template)からリポジトリを作成してください。
Please create a repository from the [template repository](https://github.com/Dai1678/product_specification_template).
### 翻訳機能を使うためにOpenAIのAPIキーを取得 / Get an OpenAI API key to use the translation feature
翻訳機能を使うためには、OpenAIのAPIキーが必要です。
[OpenAIのサイト](https://platform.openai.com/api-keys)からAPIキーを取得してください。
To use the translation feature, you need an OpenAI API key.
Please obtain an API key from the [OpenAI website](https://platform.openai.com/api-keys).
## 機能仕様書の書き方 / How to Write a Feature Specification
### 全体の流れ / Overall Flow
```mermaid
flowchart TD
A[プロジェクト / リファクタリング / 小さなタスクの開始時] --> B[mainブランチからブランチを作成]
B --> C{新規機能実装か既存機能改修か}
C -->|新規機能実装| D[テンプレートファイルをコピーして新規機能仕様書を作成]
C -->|既存機能改修| E{機能仕様書が存在するか}
E -->|存在する| F
E -->|存在しない| D
D --> F[仕様をマークダウンファイルに記載]
F --> G{PullRequestを作成済みか}
G -->|未作成| H[baseブランチをmainに設定してPullRequestを作成]
G -->|作成済み| I
H --> I[PullRequestのdescriptionに機能要件を記載]
I --> J[PullRequestを他メンバーにレビュー]
J --> K{開発フェーズ中か}
K -->|Yes| F
K -->|No| L[PullRequestのレビュー完了を確認]
L --> M[mainブランチにマージ]
M --> N[任意のドキュメントページに反映]
```
### 機能ごとにディレクトリを作成する / Create a directory for each feature
画面ごとに仕様書を作成するのではなく、機能ごとにディレクトリを作成し、その中に仕様書を作成してください。
プロダクトの機能を確認し、ディレクトリの分け方を決めておくと良いでしょう。
Create a directory for each feature instead of creating a specification file for each screen.
Review the product features and decide how to divide the directories.
### 機能仕様書のテンプレートから作成する
main branchからブランチを作成し、機能仕様書のテンプレートをコピーして作成してください。
Create a branch from the main branch and copy the feature specification template to create a feature specification.
[./docs/template/template.md](./docs/template/template.md)
```zsh
$ cd product_specification_template
$ git switch -c {branch_name}
```
## 翻訳が必要な場合 / If translation is required
翻訳元のファイルを `docs/ja/` に追加し、GitHub Actionsで`ai_translate.yml`を実行してください。
Add the original file to `docs/en/` and run `ai_translate.yml` with GitHub Actions.
## ドキュメントの公開 / Publishing Documents
このテンプレートリポジトリではドキュメントの公開機能は提供していません。
必要に応じて、GitHub PagesやBackstageなどを利用してドキュメントを公開してください。