From sdd-mcp
Generates project-specific SDD steering documents (product.md, tech.md, structure.md) by analyzing manifests like package.json/Cargo.toml, directories, and code patterns. Use for project context setup and conventions.
npx claudepluginhub yi-john-huang/sdd-mcpThis skill uses the workspace's default tool permissions.
Generate project-specific steering documents that provide context and guidance for AI-assisted development.
Generates steering documents with project standards, git workflows, and tech guidelines in .kiro/steering/ for frontend, backend, fullstack, or library projects.
Creates custom steering documents for domain-specific guidance on file types, modules, or workflows like API design standards and test patterns. Supports ALWAYS, CONDITIONAL, and MANUAL inclusion modes. Invoke via /sdd-steering-custom.
Defines project structure, naming conventions, directory layouts, and three-layer documentation model for consistent codebase organization across skills. Useful for project setup, init, or structure discussions.
Share bugs, ideas, or general feedback.
Generate project-specific steering documents that provide context and guidance for AI-assisted development.
Steering documents are markdown files in .spec/steering/ that provide project-specific context to guide AI interactions. They describe YOUR project's unique characteristics.
| Document | Purpose | Content |
|---|---|---|
product.md | Product context | Vision, users, features, goals |
tech.md | Technology stack | Languages, frameworks, tools, architecture |
structure.md | Project conventions | Directory structure, naming, patterns |
custom-*.md | Custom guidance | Specialized rules for specific contexts |
Gather information from:
package.json, Cargo.toml, pyproject.toml, pom.xml, go.mod)Create .spec/steering/product.md:
# Product Overview
## Description
{Project description from manifest or analysis}
## Vision
{Long-term product vision}
## Target Users
- **Primary:** {Main user persona}
- **Secondary:** {Other user types}
## Core Features
1. {Feature 1} - {Brief description}
2. {Feature 2} - {Brief description}
## Key Value Propositions
- {Value 1}
- {Value 2}
## Success Metrics
- {Metric 1}: {Target}
- {Metric 2}: {Target}
Create .spec/steering/tech.md:
# Technology Overview
## Stack
### Language
- **Primary:** {e.g., TypeScript, Python, Go, Rust, Java}
- **Version:** {e.g., 5.x, 3.11, 1.21}
- **Runtime:** {if applicable, e.g., Node.js, JVM, .NET}
### Frameworks
- {Framework 1}: {Purpose}
- {Framework 2}: {Purpose}
### Key Dependencies
| Package | Version | Purpose |
|---------|---------|---------|
| {dep1} | {version} | {why used} |
## Architecture
### Pattern
{e.g., Clean Architecture, MVC, Microservices, Hexagonal}
### Layers
┌─────────────────┐ │ Presentation │ Controllers, CLI, UI ├─────────────────┤ │ Application │ Services, Use Cases ├─────────────────┤ │ Domain │ Entities, Business Logic ├─────────────────┤ │ Infrastructure │ Database, External APIs └─────────────────┘
## Development Environment
### Prerequisites
- {Language runtime and version}
- {Package manager} (e.g., npm, pip, cargo, go mod, maven)
### Setup
```bash
# Clone and install dependencies
{package manager install command}
# Run development server
{dev server command}
| Command | Purpose |
|---|---|
{install} | Install dependencies |
{dev} | Development server |
{build} | Production build |
{test} | Run tests |
{lint} | Code linting |
### Step 4: Generate Structure Steering
Create `.spec/steering/structure.md`:
```markdown
# Project Structure
## Directory Layout
project-root/ ├── src/ # Source code │ ├── domain/ # Business logic │ ├── application/ # Use cases │ ├── infrastructure/ # External adapters │ └── {entry point} # Main entry point ├── tests/ # Test files ├── docs/ # Documentation └── {project manifest} # Dependencies/config
## Naming Conventions
### Files
| Type | Convention | Example |
|------|------------|---------|
| Components | {project convention} | `UserProfile.{ext}` |
| Services | {project convention} | `AuthService.{ext}` |
| Utilities | {project convention} | `format_date.{ext}` |
| Tests | {test convention} | `auth_test.{ext}` |
| Types/Interfaces | {project convention} | `user_types.{ext}` |
### Code
| Element | Convention | Example |
|---------|------------|---------|
| Classes/Types | PascalCase | `UserService` |
| Functions/Methods | {language convention} | `get_user_by_id` or `getUserById` |
| Constants | UPPER_SNAKE | `MAX_RETRY_COUNT` |
| Variables | {language convention} | `user_name` or `userName` |
| Interfaces | {project convention} | `UserRepository` or `IUserRepository` |
## Module Organization
### Import Order
1. Standard library / built-ins
2. External packages / dependencies
3. Internal modules (absolute paths)
4. Relative imports
5. Type/interface imports (if language separates them)
### Export Pattern
- Use barrel exports / index files where appropriate
- Named exports preferred over default (language-dependent)
- Public API exposed from domain layer
## Patterns
### Dependency Injection
{DI approach used, e.g., Inversify, manual}
### Error Handling
{Error handling pattern, e.g., Result types, exceptions}
### Logging
{Logging approach, e.g., structured logging}
Ensure .spec/steering/ directory exists and save documents.
This skill generates documents manually. For automated analysis, the sdd-init MCP tool creates basic steering during project initialization.