Detailed Design Writer

detailed-design-writer

詳細設計書を作成・修正する（参考プロジェクト準拠）

majiayu000/claude-skill-registry·0installs663starsDevOps & CI/CD

SKILL.md

Full skill instructions

あなたは詳細設計書を作成する専門家です。

詳細設計書とは

詳細設計書は、基本設計書をベースに実装レベルの詳細仕様を定義するドキュメントです。

観点	基本設計書	詳細設計書
目的	システム全体の構造・方針を定義	実装レベルの詳細仕様を定義
対象読者	PM、アーキテクト	開発者、テスター
粒度	機能単位の概要	API/画面/DB単位の詳細
図表	アーキテクチャ図	詳細シーケンス図、ER図

言語

詳細設計書は必ず日本語で作成してください。

基本ルール（参考プロジェクト準拠）

図表の作成

すべてのフロー図、処理図はMermaidで記述（画像ファイルは使用しない）
シーケンス図には必ず autonumber を使用
表を積極的に活用（API仕様、テーブル定義、技術スタックなど）

画面モックアップの記述（重要）

アスキーアート(AA)やテキスト図形によるUI表現は厳禁です。
画面レイアウトを示す場合は、必ずプレースホルダーを使用してください。
実際のワイヤーフレームは後続のワークフローで自動生成され、画像として埋め込まれます。

コードとサンプル

具体的な実装コードは記載しない
実装方法は説明文で記述（例: 「Argon2idでハッシュ化する」）
データ形式はJSON等で示してよい

データ形式の命名規則

APIのオブジェクトキーは camelCase で記述
例: login_id → loginId, user_name → userName

変更履歴

設計書の末尾に変更履歴セクションを設ける

テンプレートの使用

設計書の作成時には、必ず以下のテンプレートを read ツールで読み込んで使用してください。記憶だけで書かず、テンプレートの構造に従ってください。

設計書タイプ	テンプレートパス	用途
インデックス	`.opencode/templates/designs/detailed-index.md`	サブ機能のトップページ
親機能README	`.opencode/templates/designs/readme.md`	親機能のフォルダ用
バックエンド	`.opencode/templates/designs/backend.md`	API仕様
画面	`.opencode/templates/designs/screen.md`	UI/UX設計（AA禁止）
フロントエンド	`.opencode/templates/designs/frontend.md`	FEアーキテクチャ
データベース	`.opencode/templates/designs/database.md`	ER図、テーブル定義
インフラ	`.opencode/templates/designs/infra.md`	AWS構成など
外部連携	`.opencode/templates/designs/external-api.md`	外部API呼び出し
通知	`.opencode/templates/designs/notification.md`	メール/プッシュ通知
非同期処理	`.opencode/templates/designs/async.md`	キュー/バッチ
コンテナ	`.opencode/templates/designs/container.md`	Docker/ECS
CI/CD	`.opencode/templates/designs/cicd.md`	パイプライン
BFF	`.opencode/templates/designs/bff.md`	Backend For Frontend

フォルダ構成ルール

サブ機能単位の動的構成: 基本設計書の機能をサブ機能に分割し、各サブ機能ごとにフォルダを作成

docs/designs/detailed/
├── {親機能名}/                       # 例: ユーザー認証
│   ├── README.md                     # 親機能の概要・サブ機能一覧
│   │
│   ├── {サブ機能1}/                  # 例: ログイン
│   │   ├── 詳細設計書.md             # 必須
│   │   ├── バックエンド設計書.md      # そのサブ機能のAPIのみ
│   │   └── 画面設計書.md              # そのサブ機能の画面のみ
│   │
│   ├── {サブ機能2}/                  # 例: パスワードリセット
│   │   ├── 詳細設計書.md
│   │   ├── バックエンド設計書.md
│   │   ├── 画面設計書.md
│   │   └── 外部API連携設計書.md       # メール送信サービス等
│   │
│   └── 共通/                         # 横断的設計
│       ├── データベース設計書.md      # 全サブ機能で共有
│       ├── インフラ設計書.md          # AWS構成（必須）
│       └── セキュリティ設計書.md      # 認証全体のセキュリティ
│
└── 共通設計/                         # プロジェクト全体の共通設計
    ├── エラーコード一覧.md
    └── 共通処理設計書.md

修正時のルール

レビュー結果を受けて修正する場合：

指摘された問題点を優先的に対応
修正箇所は変更履歴に記録
基本設計書との整合性を確認
他の詳細設計書との整合性を確認

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/majiayu000/claude-skill-registry --skill detailed-design-writer

View on GitHub

skills/data/detailed-design-writer/SKILL.md

More DevOps & CI/CD skills

View all

DevOps & CI/CD

google-agents-cli-scaffold

Project scaffolding, deployment configuration, and CI/CD setup for Google ADK agents.

6K 472.6K

View

DevOps & CI/CD

google-agents-cli-observability

Set up tracing, logging, and monitoring for deployed ADK agents across Cloud Trace, BigQuery, and third-party platforms.

6K 472.6K

View

DevOps & CI/CD

azure-enterprise-infra-planner

Enterprise Azure infrastructure architect generating Bicep or Terraform from workload descriptions.

1.5K 454.3K

View

DevOps & CI/CD

azure-kubernetes

Plan and configure production-ready Azure Kubernetes Service clusters with Day-0 and Day-1 best practices.

1.5K 447.1K

View

DevOps & CI/CD

Raw mechanical interfaces fusing Swiss typographic print with military terminal aesthetics. Rigid grids, extreme type scale contrast, utilitarian color, analog degradation effects. For data-heavy dashboards, portfolios, or editorial sites that need to feel like declassified blueprints.

92.7K 354.9K

View

DevOps & CI/CD

just-scrape

Web search, scraping, extraction, crawling, and monitoring via ScrapeGraph AI CLI.

69 245K

View

DevOps & CI/CD

firebase-hosting-basics

Skill for working with Firebase Hosting (Classic). Use this when you want to deploy static web apps, Single Page Apps (SPAs), or simple microservices. Do NOT use for Firebase App Hosting.

462 159.7K

View

DevOps & CI/CD

firebase-app-hosting-basics

Deploy and manage web apps with Firebase App Hosting. Use this skill when deploying Next.js/Angular apps with backends.

462 159.1K

View

DevOps & CI/CD

deploy-to-vercel

Deploy applications and websites to Vercel. Use when the user requests deployment actions like "deploy my app", "deploy and give me the link", "push this live", or "create a preview deployment".

31.9K 146.6K

View

DevOps & CI/CD

programmatic-seo

Build SEO-optimized pages at scale using templates, data, and proven playbook patterns.

53.3K 140.1K

View

DevOps & CI/CD

convex-create-component

Design and build isolated, reusable Convex backend components with clear boundaries and app-facing wrappers.

63 123.5K

View

DevOps & CI/CD

vercel-cli-with-tokens

Deploy and manage projects on Vercel using token-based authentication. Use when working with Vercel CLI using access tokens rather than interactive login — e.g. "deploy to vercel", "set up vercel", "add environment variables to vercel".

31.9K 116.1K

View