SuperAPI AI Directory

generate-design

Coding & development

View repository

Updated 10-15 20:06

About this skill

Design Document Generation Skill

Overview

This skill generates the design document (design.md) for development work.

Usage Scenarios

  • When starting design based on the requirements definition document
  • When starting optimization design for performance improvement work
  • When adding a design document to an existing development work directory
  • When regenerating the design document

Required Information

  • Directory path: The docs/working/{YYYYMMDD}_{要件名}/ path of
  • Requirement Name: English kebab-case (e.g.,query-execution, export-csv, optimize-rendering)
  • Work Type (optional): "feature" (new feature development) or "performance" (performance improvement)

Prerequisites

  • requirements.md must exist (recommended)
    • Because the design is created based on the requirements definition

Procedure

1. Confirming the directory path and work type

Obtain the following from the user or the parent skill:

  • Development work directory path
  • Work type (if not specified, "feature" is the default)

2. Selecting a template

Select a template according to the work type:

  • work_type = "feature": Template for new feature development
  • work_type = "performance": Template for performance improvement

3. Generating design.md

template.md or template-performance.md Using the template fordesign.md , generate

Important: Use Nuxt UI v4 notation.

  • UFormField Use (UFormGroup is prohibited)
  • items Use the attribute (options attribute is prohibited)

3. Completion Report

Report the path of the generated file to the user.

Referencing Persistent Documents

Important: When generating the design document, refer to the persistent documents in thedocs/steering/ directory, and design in compliance with the existing architecture and coding conventions.

Documents to Reference

Document Purpose of Reference
docs/steering/03_architecture_specifications.md Check the tech stack and architecture, and verify whether the design complies with the technical policy
docs/steering/04_repository_structure.md Check the directory structure and naming conventions, and determine the appropriate file placement
docs/steering/05_development_guidelines.md Check the coding conventions, and verify whether the design examples comply with the conventions
docs/steering/06_ubiquitous_language.md Check the correct usage of project terminology, and reflect it in type definitions and variable names

Reference Rules

  1. When designing data structures: Use correct terminology from the ubiquitous language definition document, and create type definitions
  2. When designing file placement: Check the correct directory structure in the repository structure definition document
  3. When writing code examples: Review the development guidelines and architecture specification, and write code compliant with the conventions
  4. When designing APIs: Check existing API patterns in the technical specification and design for consistency
  5. When designing UI: docs/steering/05_development_guidelines.md Check the "2.4 Multilingual Support (i18n)" section of and design so that all display strings are managed via translation keys

Template

For details, refer to template.md .

Technical Specification Notes

Multilingual Support (i18n)

Important: All UI elements must support multiple languages.

When creating design documents, be sure to check the following:

  • There are no hardcoded strings in the code examples
  • Design the translation key structure and specify the additions to ja.json and en.json
  • Handle dynamic values with placeholders ({name}, {count} , etc.)

For details, refer to the "2.4 Multilingual Support (i18n)" section of docs/steering/05_development_guidelines.md .

Nuxt UI v4 Component Syntax

Important: This project uses Nuxt UI v4. Be sure to use the following syntax in code examples.

v3 → v4 Migration Reference Table

v3 (Prohibited) v4 (Required) Description
UFormGroup UFormField Form field wrapper
options attribute items attribute Options for USelect, USelectMenu, etc.

Correct syntax example (v4)

<template>
  <!-- ✅ 正しい: UFormField + items -->
  <UFormField label="データベース" name="database">
    <USelect v-model="selected" :items="databases" />
  </UFormField>

  <!-- ✅ 正しい: USelectMenu + items -->
  <USelectMenu v-model="selected" :items="options" />
</template>

Incorrect syntax example (v3)

<template>
  <!-- ❌ 間違い: UFormGroup(v3) -->
  <UFormGroup label="データベース">
    <USelect v-model="selected" :options="databases" />
  </UFormGroup>

  <!-- ❌ 間違い: options 属性(v3) -->
  <USelectMenu v-model="selected" :options="options" />
</template>

Related Skills

  • generate-working-docs - Main skill that generates all documents
  • generate-requirements - Requirements definition document generation skill
  • generate-tasklist - Task list generation skill
  • generate-testing - Test procedure document generation skill