mcpField
T
technical-specification

technical-specification

github.com/aj-geddes開発373806 回インストール34 週間前に更新
リポジトリ

technical-specification について

要件、アーキテクチャ、実装の詳細、受け入れ基準を定める技術仕様書の作成を支援するスキルです。機能仕様、設計記録、API 定義などの文書を作るプロダクト・エンジニアリングチーム向けです。

主な機能

  1. 01要件と受け入れ基準
  2. 02アーキテクチャと実装の詳細
  3. 03API 契約とデータモデル
  4. 04データベーススキーマの文書化
  5. 05セキュリティ・性能・リスクの指針

活用シーン

  1. 01機能仕様書の作成
  2. 02アーキテクチャ決定の記録
  3. 03API またはデータベース設計の定義
  4. 04技術提案書や RFC の準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill technical-specification

インストール後、Claude Code で/technical-specificationを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
api-data-models.md
authentication-endpoints.md
database-schema.md
functional-requirements.md
non-functional-requirements.md
phase-1-core-authentication.md
rate-limiting.md
templates/
doc-template.md

詳細

技術仕様

目次

概要

ソフトウェアプロジェクトのシステム要件、アーキテクチャ、実装の詳細、受け入れ基準を定義する、包括的な技術仕様を作成します。

使用する場面

  • 機能仕様書
  • システム設計書
  • 要件ドキュメント（PRD）
  • アーキテクチャ決定記録（ADR）
  • 技術提案書
  • RFC（コメント募集）
  • API 設計仕様書
  • データベーススキーマ設計

クイックスタート

最小限の動作例：

# Technical Specification: [Feature Name]

**Document Status:** Draft | Review | Approved | Implemented
**Version:** 1.0
**Author:** John Doe
**Date:** 2025-01-15
**Reviewers:** Jane Smith, Bob Johnson
**Last Updated:** 2025-01-15

## Executive Summary

Brief 2-3 sentence overview of what this spec covers and why it's being built.

**Problem:** What problem are we solving?
**Solution:** High-level description of the solution
**Impact:** Expected business/user impact

---

## 1. Background

### Context

Provide background on why this feature is needed:

// ... (see reference guides for full implementation)

リファレンスガイド

詳細な実装については、references/ ディレクトリを参照してください。

ガイド内容
機能要件機能要件
非機能要件非機能要件
データベーススキーマデータベーススキーマ
API データモデルAPI データモデル
認証エンドポイント認証エンドポイント
レート制限レート制限
フェーズ 1：コア認証フェーズ 1：コア認証（第 1～2 週）、フェーズ 2：メール認証（第 3 週）、フェーズ 3：ソーシャルログイン（第 4 週）、フェーズ 4：セキュリティ機能（第 5 週）（ほか 1 件）

ベストプラクティス

✅ 推奨事項
  • 各要件に受け入れ基準を含めます
  • アーキテクチャ図を用意します
  • API コントラクトを文書化します
  • パフォーマンス要件を明記します
  • リスクとその緩和策を列挙します
  • 実装スケジュールを含めます
  • 成功指標を追加します
  • セキュリティに関する考慮事項を文書化します
  • 仕様にバージョンを付けます
  • ステークホルダーによるレビューを受けます
❌ 避けるべき事項
  • 要件を曖昧にしないでください
  • 非機能要件を省略しないでください
  • セキュリティを忘れないでください
  • 代替案を無視しないでください
  • テスト戦略を省略しないでください
  • 監視や可観測性を忘れないでください
  • 疑問点を未解決のままにしないでください

コメント

Markdown 対応