{"id":19551369,"url":"https://github.com/dai1678/product_specification_template","last_synced_at":"2026-05-04T18:37:22.600Z","repository":{"id":260853514,"uuid":"882512507","full_name":"Dai1678/product_specification_template","owner":"Dai1678","description":"あなたのプロダクトの機能仕様書を管理・公開するためのリポジトリです。","archived":false,"fork":false,"pushed_at":"2024-11-17T12:23:26.000Z","size":79,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T07:16:28.743Z","etag":null,"topics":["deno","documentation","github-actions","openai","textlint"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dai1678.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-03T01:08:06.000Z","updated_at":"2024-11-17T12:23:29.000Z","dependencies_parsed_at":"2025-01-08T20:33:07.469Z","dependency_job_id":null,"html_url":"https://github.com/Dai1678/product_specification_template","commit_stats":null,"previous_names":["dai1678/product_specification_template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dai1678%2Fproduct_specification_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dai1678%2Fproduct_specification_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dai1678%2Fproduct_specification_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dai1678%2Fproduct_specification_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dai1678","download_url":"https://codeload.github.com/Dai1678/product_specification_template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240807564,"owners_count":19860772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deno","documentation","github-actions","openai","textlint"],"created_at":"2024-11-11T04:13:40.908Z","updated_at":"2026-05-04T18:37:22.562Z","avatar_url":"https://github.com/Dai1678.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# プロダクト機能仕様書 / Product Feature Specification\n\nあなたのプロダクトの機能仕様書を管理・公開するためのリポジトリです。\n\nThis repository is for managing and publishing the feature specifications of your product.\n\n---\n\n## このリポジトリで管理するもの / Items Managed in This Repository\n- [/docs](./docs): プロダクトの機能仕様書を管理するディレクトリ  \nDirectory for managing product feature specifications\n\n## セットアップ / Setup\n### テンプレートリポジトリからリポジトリを作成 / Create a repository from the template repository\n[テンプレートリポジトリ](https://github.com/Dai1678/product_specification_template)からリポジトリを作成してください。\n\nPlease create a repository from the [template repository](https://github.com/Dai1678/product_specification_template).\n\n### 翻訳機能を使うためにOpenAIのAPIキーを取得 / Get an OpenAI API key to use the translation feature\n翻訳機能を使うためには、OpenAIのAPIキーが必要です。  \n[OpenAIのサイト](https://platform.openai.com/api-keys)からAPIキーを取得してください。\n\nTo use the translation feature, you need an OpenAI API key.  \nPlease obtain an API key from the [OpenAI website](https://platform.openai.com/api-keys).\n\n## 機能仕様書の書き方 / How to Write a Feature Specification\n### 全体の流れ / Overall Flow\n\n```mermaid\nflowchart TD\n    A[プロジェクト / リファクタリング / 小さなタスクの開始時] --\u003e B[mainブランチからブランチを作成]\n    B --\u003e C{新規機能実装か既存機能改修か}\n    C --\u003e|新規機能実装| D[テンプレートファイルをコピーして新規機能仕様書を作成]\n    C --\u003e|既存機能改修| E{機能仕様書が存在するか}\n    E --\u003e|存在する| F\n    E --\u003e|存在しない| D\n    D --\u003e F[仕様をマークダウンファイルに記載]\n    F --\u003e G{PullRequestを作成済みか}\n    G --\u003e|未作成| H[baseブランチをmainに設定してPullRequestを作成]\n    G --\u003e|作成済み| I\n    H --\u003e I[PullRequestのdescriptionに機能要件を記載]\n    I --\u003e J[PullRequestを他メンバーにレビュー]\n    J --\u003e K{開発フェーズ中か}\n    K --\u003e|Yes| F\n    K --\u003e|No| L[PullRequestのレビュー完了を確認]\n    L --\u003e M[mainブランチにマージ]\n    M --\u003e N[任意のドキュメントページに反映]\n```\n\n### 機能ごとにディレクトリを作成する / Create a directory for each feature\n画面ごとに仕様書を作成するのではなく、機能ごとにディレクトリを作成し、その中に仕様書を作成してください。\n\nプロダクトの機能を確認し、ディレクトリの分け方を決めておくと良いでしょう。\n\nCreate a directory for each feature instead of creating a specification file for each screen.  \nReview the product features and decide how to divide the directories.\n\n### 機能仕様書のテンプレートから作成する\nmain branchからブランチを作成し、機能仕様書のテンプレートをコピーして作成してください。\n\nCreate a branch from the main branch and copy the feature specification template to create a feature specification.\n\n[./docs/template/template.md](./docs/template/template.md)\n\n```zsh\n$ cd product_specification_template\n$ git switch -c {branch_name}\n```\n\n## 翻訳が必要な場合 / If translation is required\n翻訳元のファイルを `docs/ja/` に追加し、GitHub Actionsで`ai_translate.yml`を実行してください。\n\nAdd the original file to `docs/en/` and run `ai_translate.yml` with GitHub Actions.\n\n## ドキュメントの公開 / Publishing Documents\nこのテンプレートリポジトリではドキュメントの公開機能は提供していません。  \n必要に応じて、GitHub PagesやBackstageなどを利用してドキュメントを公開してください。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdai1678%2Fproduct_specification_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdai1678%2Fproduct_specification_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdai1678%2Fproduct_specification_template/lists"}