登录
下载
技能 硬件工程 创建自定义项目规范文档

创建自定义项目规范文档

v20260427
kiro-steering-custom
用于为项目中的特定领域（如API标准、测试策略、安全机制等）创建高度专业化、可复用的指导文档。它通过分析现有代码库，提炼出领域特有的最佳实践和技术模式，帮助团队建立完整的项目知识库，确保开发规范的一致性。
架构 设计 文档撰写 最佳实践 代码分析 工程 规范
获取技能
360 次下载
概览

Kiro Custom Steering Creation

<background_information> Role: Create specialized steering documents beyond core files (product, tech, structure).

Mission: Help users create domain-specific project memory for specialized areas.

Success Criteria:

  • Custom steering captures specialized patterns
  • Follows same granularity principles as core steering
  • Provides clear value for specific domain </background_information>
### Step 1: Gather Context

If steering context is already available from conversation, skip redundant file reads. Otherwise:

  • Check {{KIRO_DIR}}/settings/templates/steering-custom/ for available templates
  • Read rules/steering-principles.md from this skill's directory for steering principles

Workflow

  1. Ask user for custom steering needs:

    • Domain/topic (e.g., "API standards", "testing approach")
    • Specific requirements or patterns to document

  2. Check if template exists:

    • Load from {{KIRO_DIR}}/settings/templates/steering-custom/{name}.md if available
    • Use as starting point, customize based on project

  3. Analyze codebase (JIT) for relevant patterns:

Parallel Research

The following research areas are independent and can be executed in parallel:

  1. Template & principles: Load matching template and steering-principles.md
  2. Domain patterns: Analyze codebase for domain-specific patterns using Glob/Grep/Read

If multi-agent is enabled, spawn sub-agents for each area above. Otherwise execute sequentially.

After all parallel research completes, synthesize findings for steering document.

  1. Generate custom steering:

    • Follow template structure if available
    • Apply principles from rules/steering-principles.md from this skill's directory
    • Focus on patterns, not exhaustive lists
    • Keep to 100-200 lines (2-3 minute read)

  2. Create file in {{KIRO_DIR}}/steering/{name}.md

Available Templates

Templates available in {{KIRO_DIR}}/settings/templates/steering-custom/:

  1. api-standards.md - REST/GraphQL conventions, error handling
  2. testing.md - Test organization, mocking, coverage
  3. security.md - Auth patterns, input validation, secrets
  4. database.md - Schema design, migrations, query patterns
  5. error-handling.md - Error types, logging, retry strategies
  6. authentication.md - Auth flows, permissions, session management
  7. deployment.md - CI/CD, environments, rollback procedures

Load template when needed, customize for project.

Steering Principles

From rules/steering-principles.md (in this skill's directory):

  • Patterns over lists: Document patterns, not every file/component
  • Single domain: One topic per file
  • Concrete examples: Show patterns with code
  • Maintainable size: 100-200 lines typical
  • Security first: Never include secrets or sensitive data

Tool guidance

  • Read: Load template, analyze existing code
  • Glob: Find related files for pattern analysis
  • Grep: Search for specific patterns
  • Bash with ls: Understand relevant structure

JIT Strategy: Load template only when creating that type of steering.

Output description

Chat summary with file location (file created directly).

✅ Custom Steering Created

## Created:
- {{KIRO_DIR}}/steering/api-standards.md

## Based On:
- Template: api-standards.md
- Analyzed: src/api/ directory patterns
- Extracted: REST conventions, error format

## Content:
- Endpoint naming patterns
- Request/response format
- Error handling conventions
- Authentication approach

Review and customize as needed.

Examples

Success: API Standards

Input: "Create API standards steering"
Action: Load template, analyze src/api/, extract patterns
Output: api-standards.md with project-specific REST conventions

Success: Testing Strategy

Input: "Document our testing approach"
Action: Load template, analyze test files, extract patterns
Output: testing.md with test organization and mocking strategies

Safety & Fallback

  • No template: Generate from scratch based on domain knowledge
  • Security: Never include secrets (load principles)
  • Validation: Ensure doesn't duplicate core steering content

Notes

  • Templates are starting points, customize for project
  • Follow same granularity principles as core steering
  • All steering files loaded as project memory
  • Custom files equally important as core files
  • Avoid documenting agent-specific tooling directories (e.g. .cursor/, .gemini/, .claude/)
  • Light references to {{KIRO_DIR}}/specs/ and {{KIRO_DIR}}/steering/ are acceptable; avoid other .kiro/ directories
信息
Category 硬件工程
Name kiro-steering-custom
版本 v20260427
大小 4.76KB
Source gotalab/cc-sdd
更新时间 2026-04-28
语言
简体中文
English