- はじめに
- 【基本テンプレ：Feature Specification Document（機能仕様書）】
- Document Title:
- 1. Overview (概要)
- 2. Background / Context (背景・目的)
- 3. Requirements (要件一覧)
- 4. User Stories / Acceptance Criteria (ユーザーストーリーと受け入れ条件)
- 5. UI/UX Design (画面デザイン)
- 6. API Changes (API仕様変更点、必要であれば)
- 7. Database Changes (DB変更点、必要であれば)
- 8. Non-Functional Requirements (非機能要件)
- 9. Risks / Dependencies (リスクと依存関係)
- 10. Test Plan Overview (簡易テスト計画概要)
- 11. Timeline (スケジュール)
- 12. Approval (承認者)
- 【応用テンプレ：Test Plan on Confluence（テスト計画書例）】
- 【ポイント：実際使って分かったConfluence英語仕様書で大事なこと】
- おわりに：まずは「コピペ＆アレンジ」でOK！
はじめに
こんにちは！
海外でC# WPF開発をしている日本人エンジニアです。
今回は、Confluenceでよく使う「仕様書」「設計ドキュメント」「テスト計画書」向けの英語テンプレート例をまとめました。
「とりあえず何か書かないと…でも英語でどう書けばいいか分からない…！」
そんな時のために、僕が実際に使ってたリアルテンプレートを、そのまま公開します！
【基本テンプレ：Feature Specification Document（機能仕様書）】
Document Title:
Feature Specification: [Feature Name]
1. Overview (概要)
This document describes the functional specifications for the [Feature Name].
The goal of this feature is to [short description of the purpose, e.g., improve user registration process, enhance search functionality].
2. Background / Context (背景・目的)
Currently, [briefly describe the current problem, user feedback, or business goal].
To address this, we are introducing [Feature Name].
3. Requirements (要件一覧)
| ID | Requirement Description | Priority (High/Medium/Low) | Remarks |
|---|---|---|---|
| RQ-001 | The system should allow users to reset their password via email link. | High | N/A |
| RQ-002 | The email link should expire after 24 hours. | Medium | Security measure |
4. User Stories / Acceptance Criteria (ユーザーストーリーと受け入れ条件)
User Story Example:
As a registered user, I want to reset my password so that I can regain access if I forget it.
Acceptance Criteria Example:
- Given that the user enters a valid email, when they click “Reset Password”, then the system should send a reset link to their email.
- The reset link should expire after 24 hours.
- If the email is not registered, the system should display an error message.
5. UI/UX Design (画面デザイン)
- Mockups: [Attach Figma / PDF / Image link]
- Wireframes: [Link]
- UI Flow: [Link to User Flow Diagram]
6. API Changes (API仕様変更点、必要であれば)
| Endpoint | Method | Request | Response |
|---|---|---|---|
| /api/user/reset-password | POST | { “email”: “user@example.com” } | { “status”: “success” } |
7. Database Changes (DB変更点、必要であれば)
- New Table: PasswordResetToken
- Columns: id, user_id, token, expiration_date
8. Non-Functional Requirements (非機能要件)
- Performance: The reset email should be sent within 5 seconds.
- Security: Token must be unique and encrypted.
9. Risks / Dependencies (リスクと依存関係)
- Dependency on Email Service Provider (Amazon SES)
- Potential delay in deployment if email template is not finalized.
10. Test Plan Overview (簡易テスト計画概要)
Testing will cover the following:
- Positive cases: Successful password reset
- Negative cases: Invalid email, expired token, wrong token
- Edge cases: High load, spam filters blocking emails
Full test cases will be documented separately in TestRail.
11. Timeline (スケジュール)
| Milestone | Target Date |
|---|---|
| Design Finalization | July 15 |
| Development Complete | August 5 |
| QA Start | August 7 |
| Production Release | August 20 |
12. Approval (承認者)
| Name | Role | Status |
|---|---|---|
| John Doe | Product Manager | Approved |
| Jane Smith | QA Lead | Approved |
【応用テンプレ：Test Plan on Confluence（テスト計画書例）】
Document Title:
Test Plan: [Feature Name]
1. Scope (スコープ)
This test plan covers the testing activities for the [Feature Name].
2. Test Objectives (テストの目的)
- To ensure the feature meets the acceptance criteria
- To identify potential defects before production release
3. Test Types (テストタイプ)
- Functional Testing
- Regression Testing
- Negative Testing
- Performance Testing (if applicable)
4. Test Environment (テスト環境)
- Application Version: [e.g., v1.2.3]
- Test Environment: [e.g., Staging]
- Database: [e.g., TestDB_v2]
5. Test Schedule (テストスケジュール)
| Phase | Start Date | End Date |
|---|---|---|
| Test Case Preparation | July 10 | July 12 |
| Test Execution | July 13 | July 17 |
| Bug Fix Verification | July 18 | July 19 |
6. Risks and Assumptions (リスクと前提条件)
- Delay in environment setup may affect test execution schedule.
- All API endpoints are assumed to be stable by the start of testing.
7. Test Coverage Summary (テストカバレッジ概要)
| Test Area | No. of Test Cases | Status |
|---|---|---|
| User Registration | 10 | In Progress |
| Password Reset | 8 | Completed |
| Error Handling | 5 | Planned |
【ポイント：実際使って分かったConfluence英語仕様書で大事なこと】
✅ 見出しはシンプルに（Numbering推奨）
✅ テーブル多用（視覚的に読みやすくなる）
✅ 不明確な箇所は「TBD（To Be Decided）」と明記（放置しない）
✅ 他ツール（Figma、JIRA、TestRail）へのリンクを必ず貼る
✅ 最初から「英語が不安だから…」と小さくならず、とにかく書くこと！
おわりに：まずは「コピペ＆アレンジ」でOK！
僕も最初はConfluenceでドキュメント作るのがめちゃくちゃ怖かったです（笑）
でも、こういうテンプレをベースに「自分用テンプレートストック」を作っていくのが一番の近道でした。
コメント