engineering-docs プラグイン
22 engineering documentation skills covering the complete software lifecycle.
engineering-docs プラグインのインストール方法
両方のコマンドを Claude Code 内で実行してください。最初のコマンドで marketplace を一度追加し、2 番目のコマンドでプラグインをインストールします。
/plugin marketplace add fattain-naime/engineering-docs
/plugin install engineering-docs@engineering-docsengineering-docs の内容
プラグイン自身のファイルから読み込まれた 28 個のパーツ です。
Agent 4
@agent-engineering-docs:name として呼び出し- @agent-engineering-docs:api-designersonnet
|
- @agent-engineering-docs:architecture-reviewersonnet
|
- @agent-engineering-docs:documentation-generatorsonnet
|
- @agent-engineering-docs:test-strategistsonnet
|
SKILL 22
タスクが一致したときに Claude が読み込みます- admin-access-control-specification
Specify admin roles, permissions, and every admin-facing control in a system - a full role-permission matrix (RBAC), the principle of least privilege applied concretely, admin action audit logging, and emergency/break-glass access procedures. Use whenever a system has more than one privilege level, before building the admin panel or access-control logic.
- api-design-document
Design a production-ready API specification aligned with OpenAPI 3.1 standards. Covers resource modeling, endpoint design, request/response contracts, authentication, versioning strategy, error handling, rate limiting, and pagination. Use when designing a new REST, GraphQL, or event-driven API.
- architecture-decision-record
Create a standalone Architecture Decision Record (ADR) for a single significant architectural decision. Captures context, decision, alternatives considered, and consequences. ADRs are immutable - once accepted, they are never edited, only superseded by a new ADR.
- business-concept
Turn a raw business idea into a complete business concept document. Covers problem, target users, value proposition, monetization, scope, timeline, and constraints. Use as the first step before any technical documentation.
- database-design-document
Design a production database schema including ERD, table definitions, data dictionary, indexing strategy, normalization decisions, and migration plan. Use when designing a new database, adding major entities, or documenting an existing schema.
- deployment-plan
Write a production deployment plan covering environment specs, deployment strategy (Blue-Green, Canary, Rolling, or Direct), step-by-step execution runsheet, go/no-go criteria, monitoring plan, and rollback procedure. Use before any non-trivial production release.
- design-system-specification
Design a production-ready Design System and UI/UX visual style guide. Covers design tokens (colors, typography, spacing, shadows, radius), components (buttons, inputs, cards, tables, modals, navigation), layouts, interaction/hover states, iconography, motion design, responsive behavior, accessibility (WCAG 2.2), and dark/light mode rules. Use when starting a new website/app design or standardizing existing branding.
- disaster-recovery-plan
Write a disaster recovery and business continuity plan defining RTO/RPO targets, backup and failover procedures, DR tiers, and a recovery drill cadence for surviving major infrastructure loss, data corruption, ransomware, or regional outages. Use before launch of any system holding critical or financial data, or to formalize continuity commitments for compliance (PCI-DSS, SOC 2, ISO 22301).
- implementation-plan
Create a phased implementation roadmap that sequences the technical build of an entire project - build order, module dependencies, environment/tooling setup, per-phase Definition of Ready/Done, and integration checkpoints. Use after the project plan and architecture exist, to turn "what we're building and when" into "in what technical order we actually build it."
- incident-postmortem
Write a blameless post-incident review (post-mortem / RCA) that documents what happened, the timeline, root cause analysis, impact assessment, and concrete action items to prevent recurrence. Follows Google SRE blameless post-mortem culture.
- project-plan
Create a project delivery plan covering scope, milestones, timeline, work breakdown, resourcing, stakeholder roles (RACI), dependencies, budget, quality gates, and a project-level risk register. Use at the start of any project to define who is building what, in what order, by when - before any code is written.
- security-threat-model
Produce a structured security threat model using the STRIDE framework, identify trust boundaries, enumerate attack vectors, assess risk, and define concrete mitigations. Use when reviewing security of a new feature, system, or integration.
- slo-error-budget-document
Define Service Level Indicators (SLIs), Service Level Objectives (SLOs), and error budgets for a service, including multi-window multi-burn-rate alerting and an error budget policy. Use when establishing reliability targets, negotiating an external SLA, or deciding how much risk a team can spend on shipping velocity versus reliability work.
- system-architecture-document
Create a System Architecture Document (SAD) with C4 model diagrams, 4+1 view decomposition, integration maps, NFR constraints, and an Architecture Decision Record log. Use when documenting how an entire system or major subsystem is structured.
- technical-blueprint
Write a Technical Design Document (TDD) / Software Design Document (SDD) that details how a specific feature or component will be built. Covers problem statement, proposed design, data model, API contracts, alternatives considered, security threat analysis, test plan, and rollback plan. Use when an engineer or team needs to align on the implementation approach before writing code.
- technical-feasibility-study
Assess whether a proposed technical solution is viable given the current stack, team, timeline, and constraints. Produces a go/no-go recommendation with evidence. Use before committing engineering resources to design or implementation.
- technical-runbook
Write a production operations runbook that provides on-call engineers with step-by-step procedures for operating, monitoring, and recovering a system. Covers system overview, alert response procedures, common failure modes, diagnostic commands, escalation paths, and maintenance procedures. Modeled on Google SRE runbook standards.
- technical-specification
Write a technical specification (SRS/TSD) that captures stakeholder needs, system requirements, functional behavior, non-functional constraints, and acceptance criteria. Use when starting any significant engineering initiative.
- test-strategy-document
Create a production-ready Testing Strategy and QA Execution Plan. Covers testing levels (unit, integration, E2E, performance), mocking boundaries, test environment matrix, code coverage thresholds, and automated CI pipeline runsheets. Use when establishing a QA framework for a new system or feature set.
- user-personas-behavior
Define who a product is for, what they're trying to accomplish, how success is measured, and what to instrument to know if it's working. Covers user personas (goal- and behavior-based, not demographic), jobs-to-be-done, success metrics/KPIs, and an analytics/event-tracking plan. Use before or alongside requirements gathering so "who is this for and how do we know it's working" is answered explicitly.
- using-engineering-docs
The entry point for this plugin. Give it a raw project idea or concept and it takes over: runs a discovery conversation, decides which document skills apply and in what order, then generates that full document set one skill at a time. Use when you have an idea and don't yet know which documents you need.
- ux-flow-specification
Document the complete user experience of a product - information architecture, user journeys, screen-by-screen flows, and every UI state (loading, empty, error, success) - independent of visual styling. Use to define exactly how a user moves through a product before or alongside implementation, so navigation and edge-case behavior are decided upfront rather than improvised.
Hook 1
以下のイベントで実行されます- SessionStartcommand
startup|resume|clear|compact|fork
MCP server 1
プラグインとともに起動します- engineering-docsstdio
node ${CLAUDE_PLUGIN_ROOT}/scripts/validate.js
Claude Code での engineering-docs の使用方法
Agent を名前で指定してください:
@agent-engineering-docs:api-designer
@agent-engineering-docs:architecture-reviewerSKILL にコマンドは不要です。リクエストが説明と一致したときに Claude が読み込みます。
更新、オフ、または削除
- プラグインを更新 (shell)
- claude plugin update engineering-docs@engineering-docs
- marketplace を更新
- /plugin marketplace update engineering-docs
- 一時的にオフにする
- /plugin disable engineering-docs@engineering-docs
- 削除する
- /plugin uninstall engineering-docs@engineering-docs
engineering-docs のスキル
- admin-access-control-specificationfattain-naime/engineering-docs
Specify admin roles, permissions, and every admin-facing control in a system - a full role-permission matrix (RBAC), the principle of least privilege applied concretely, admin action audit logging, and emergency/break-glass access procedures. Use whenever a system has more than one privilege level, before building the admin panel or access-control logic.
2件のファイル6スター - api-design-documentfattain-naime/engineering-docs
Design a production-ready API specification aligned with OpenAPI 3.1 standards. Covers resource modeling, endpoint design, request/response contracts, authentication, versioning strategy, error handling, rate limiting, and pagination. Use when designing a new REST, GraphQL, or event-driven API.
2件のファイル6スター - architecture-decision-recordfattain-naime/engineering-docs
Create a standalone Architecture Decision Record (ADR) for a single significant architectural decision. Captures context, decision, alternatives considered, and consequences. ADRs are immutable - once accepted, they are never edited, only superseded by a new ADR.
2件のファイル6スター - business-conceptfattain-naime/engineering-docs
Turn a raw business idea into a complete business concept document. Covers problem, target users, value proposition, monetization, scope, timeline, and constraints. Use as the first step before any technical documentation.
2件のファイル6スター - database-design-documentfattain-naime/engineering-docs
Design a production database schema including ERD, table definitions, data dictionary, indexing strategy, normalization decisions, and migration plan. Use when designing a new database, adding major entities, or documenting an existing schema.
2件のファイル6スター - deployment-planfattain-naime/engineering-docs
Write a production deployment plan covering environment specs, deployment strategy (Blue-Green, Canary, Rolling, or Direct), step-by-step execution runsheet, go/no-go criteria, monitoring plan, and rollback procedure. Use before any non-trivial production release.
2件のファイル6スター - design-system-specificationfattain-naime/engineering-docs
Design a production-ready Design System and UI/UX visual style guide. Covers design tokens (colors, typography, spacing, shadows, radius), components (buttons, inputs, cards, tables, modals, navigation), layouts, interaction/hover states, iconography, motion design, responsive behavior, accessibility (WCAG 2.2), and dark/light mode rules. Use when starting a new website/app design or standardizing existing branding.
2件のファイル6スター - disaster-recovery-planfattain-naime/engineering-docs
Write a disaster recovery and business continuity plan defining RTO/RPO targets, backup and failover procedures, DR tiers, and a recovery drill cadence for surviving major infrastructure loss, data corruption, ransomware, or regional outages. Use before launch of any system holding critical or financial data, or to formalize continuity commitments for compliance (PCI-DSS, SOC 2, ISO 22301).
2件のファイル6スター - implementation-planfattain-naime/engineering-docs
Create a phased implementation roadmap that sequences the technical build of an entire project - build order, module dependencies, environment/tooling setup, per-phase Definition of Ready/Done, and integration checkpoints. Use after the project plan and architecture exist, to turn "what we're building and when" into "in what technical order we actually build it."
2件のファイル6スター - incident-postmortemfattain-naime/engineering-docs
Write a blameless post-incident review (post-mortem / RCA) that documents what happened, the timeline, root cause analysis, impact assessment, and concrete action items to prevent recurrence. Follows Google SRE blameless post-mortem culture.
2件のファイル6スター - project-planfattain-naime/engineering-docs
Create a project delivery plan covering scope, milestones, timeline, work breakdown, resourcing, stakeholder roles (RACI), dependencies, budget, quality gates, and a project-level risk register. Use at the start of any project to define who is building what, in what order, by when - before any code is written.
2件のファイル6スター - security-threat-modelfattain-naime/engineering-docs
Produce a structured security threat model using the STRIDE framework, identify trust boundaries, enumerate attack vectors, assess risk, and define concrete mitigations. Use when reviewing security of a new feature, system, or integration.
2件のファイル6スター - slo-error-budget-documentfattain-naime/engineering-docs
Define Service Level Indicators (SLIs), Service Level Objectives (SLOs), and error budgets for a service, including multi-window multi-burn-rate alerting and an error budget policy. Use when establishing reliability targets, negotiating an external SLA, or deciding how much risk a team can spend on shipping velocity versus reliability work.
2件のファイル6スター - system-architecture-documentfattain-naime/engineering-docs
Create a System Architecture Document (SAD) with C4 model diagrams, 4+1 view decomposition, integration maps, NFR constraints, and an Architecture Decision Record log. Use when documenting how an entire system or major subsystem is structured.
3件のファイル6スター - technical-blueprintfattain-naime/engineering-docs
Write a Technical Design Document (TDD) / Software Design Document (SDD) that details how a specific feature or component will be built. Covers problem statement, proposed design, data model, API contracts, alternatives considered, security threat analysis, test plan, and rollback plan. Use when an engineer or team needs to align on the implementation approach before writing code.
2件のファイル6スター - technical-feasibility-studyfattain-naime/engineering-docs
Assess whether a proposed technical solution is viable given the current stack, team, timeline, and constraints. Produces a go/no-go recommendation with evidence. Use before committing engineering resources to design or implementation.
2件のファイル6スター - technical-runbookfattain-naime/engineering-docs
Write a production operations runbook that provides on-call engineers with step-by-step procedures for operating, monitoring, and recovering a system. Covers system overview, alert response procedures, common failure modes, diagnostic commands, escalation paths, and maintenance procedures. Modeled on Google SRE runbook standards.
2件のファイル6スター - technical-specificationfattain-naime/engineering-docs
Write a technical specification (SRS/TSD) that captures stakeholder needs, system requirements, functional behavior, non-functional constraints, and acceptance criteria. Use when starting any significant engineering initiative.
2件のファイル6スター - test-strategy-documentfattain-naime/engineering-docs
Create a production-ready Testing Strategy and QA Execution Plan. Covers testing levels (unit, integration, E2E, performance), mocking boundaries, test environment matrix, code coverage thresholds, and automated CI pipeline runsheets. Use when establishing a QA framework for a new system or feature set.
2件のファイル6スター - user-personas-behaviorfattain-naime/engineering-docs
Define who a product is for, what they're trying to accomplish, how success is measured, and what to instrument to know if it's working. Covers user personas (goal- and behavior-based, not demographic), jobs-to-be-done, success metrics/KPIs, and an analytics/event-tracking plan. Use before or alongside requirements gathering so "who is this for and how do we know it's working" is answered explicitly.
2件のファイル6スター - using-engineering-docsfattain-naime/engineering-docs
The entry point for this plugin. Give it a raw project idea or concept and it takes over: runs a discovery conversation, decides which document skills apply and in what order, then generates that full document set one skill at a time. Use when you have an idea and don't yet know which documents you need.
3件のファイル6スター - ux-flow-specificationfattain-naime/engineering-docs
Document the complete user experience of a product - information architecture, user journeys, screen-by-screen flows, and every UI state (loading, empty, error, success) - independent of visual styling. Use to define exactly how a user moves through a product before or alongside implementation, so navigation and edge-case behavior are decided upfront rather than improvised.
2件のファイル6スター
engineering-docs プラグインに関する質問
engineering-docs プラグインをインストールするにはどうすればよいですか。
Claude Code で /plugin marketplace add fattain-naime/engineering-docs を実行し、続いて /plugin install engineering-docs@engineering-docs を実行します。
engineering-docs プラグインには何が含まれていますか。
engineering-docs には 4 件のエージェント, 22 件のスキル, フック, MCP サーバー が含まれています。
engineering-docs にはどの Agent が含まれていますか?
api-designer, architecture-reviewer, documentation-generator, test-strategist です。@agent-engineering-docs:api-designer で呼び出せます。
engineering-docs プラグインを更新または削除するにはどうすればよいですか?
shell で claude plugin update engineering-docs@engineering-docs を使用して更新するか、/plugin の Installed タブから行ってください。削除するには /plugin uninstall engineering-docs@engineering-docs を使用してください。
engineering-docs プラグインのライセンスは何ですか?
プラグインのマニフェストに記載されている MIT です。