@soulcraft/kits 1.0.0

package/src/kits/technical-specification.ts

@@ -0,0 +1,363 @@
+/**
+ * @module @soulcraft/kits/kits/technical-specification
+ * @description Detailed technical specification document for software projects
+ *
+ * Generated from: kits/technical-specification/kit.json
+ * Do not edit this file directly — edit the source kit.json and re-run `bun run build:kits`.
+ */
+
+import type { SoulcraftKitConfig } from '@soulcraft/kit-schema';
+
+/**
+ * Technical Specification kit configuration.
+ *
+ * @description Detailed technical specification document for software projects
+ * @see {@link SoulcraftKitConfig}
+ */
+const technicalSpecification: SoulcraftKitConfig = {
+	"$schema": "https://soulcraft.com/schemas/kit/v2.json",
+	"id": "technical-specification",
+	"name": "Technical Specification",
+	"description": "Detailed technical specification document for software projects",
+	"version": "1.0.0",
+	"author": {
+		"name": "Soulcraft Labs",
+		"email": "kits@soulcraft.com",
+		"url": "https://soulcraft.com"
+	},
+	"status": "released",
+	"icon": "🏗️",
+	"longDescription": "Complete technical specification template with architecture overview, data models, API design, security considerations, and implementation details. Structured for engineering review and stakeholder sign-off.",
+	"tags": [
+		"technical",
+		"specification",
+		"architecture",
+		"design"
+	],
+	"role": "primary",
+	"type": "soulcraft",
+	"variables": [
+		{
+			"key": "projectName",
+			"label": "Project Name",
+			"description": "The name of the system or feature being specified",
+			"type": "string",
+			"required": true,
+			"example": "Customer Portal"
+		},
+		{
+			"key": "author",
+			"label": "Technical Lead",
+			"description": "The engineer authoring this specification",
+			"type": "string",
+			"required": false,
+			"example": "Your Name"
+		},
+		{
+			"key": "version",
+			"label": "Spec Version",
+			"description": "The version number of this specification",
+			"type": "string",
+			"required": false,
+			"example": "1.0",
+			"default": "1.0"
+		}
+	],
+	"shared": {
+		"industry": "software-development",
+		"category": "development",
+		"aiExpertise": [
+			"Software architecture design",
+			"API contract definition",
+			"Data model design",
+			"Security threat modeling",
+			"Non-functional requirements specification"
+		],
+		"dataModelHints": [
+			"concept",
+			"interface",
+			"resource",
+			"document"
+		],
+		"suggestions": [
+			{
+				"label": "Write a spec section",
+				"prompt": "Help me write a technical specification section"
+			},
+			{
+				"label": "Define architecture",
+				"prompt": "Help me define and document the system architecture"
+			},
+			{
+				"label": "Document APIs",
+				"prompt": "Help me document the API contracts and interfaces"
+			},
+			{
+				"label": "List requirements",
+				"prompt": "Help me define technical requirements and constraints"
+			},
+			{
+				"label": "Create diagrams",
+				"prompt": "Help me create a system diagram for my architecture"
+			},
+			{
+				"label": "Review spec",
+				"prompt": "Show me my technical specification structure and completeness"
+			}
+		],
+		"dataModel": {
+			"entities": [
+				{
+					"domain": "component",
+					"type": "Concept",
+					"description": "A software component or service within the system",
+					"products": {
+						"workshop": {
+							"view": "graph",
+							"icon": "🔧"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": true
+						}
+					}
+				},
+				{
+					"domain": "interface",
+					"type": "Concept",
+					"description": "An API contract or interface a component exposes",
+					"products": {
+						"workshop": {
+							"view": "tree",
+							"icon": "⚡"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": true
+						}
+					}
+				},
+				{
+					"domain": "dataModel",
+					"type": "Concept",
+					"description": "A data schema or model used by the system",
+					"products": {
+						"workshop": {
+							"view": "graph",
+							"icon": "🗂️"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": true
+						}
+					}
+				},
+				{
+					"domain": "service",
+					"type": "Concept",
+					"description": "An external or internal service depended on by components",
+					"products": {
+						"workshop": {
+							"view": "graph",
+							"icon": "☁️"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": false
+						}
+					}
+				},
+				{
+					"domain": "database",
+					"type": "Thing",
+					"description": "A data store or persistence layer used by the system",
+					"products": {
+						"workshop": {
+							"view": "graph",
+							"icon": "🗄️"
+						},
+						"academy": {
+							"mapsTo": "resource",
+							"assessable": false
+						}
+					}
+				}
+			],
+			"relationships": [
+				{
+					"from": "component",
+					"to": "component",
+					"verb": "DependsOn",
+					"description": "Component requires another component to function"
+				},
+				{
+					"from": "component",
+					"to": "interface",
+					"verb": "Implements",
+					"description": "Component implements this interface contract"
+				},
+				{
+					"from": "component",
+					"to": "database",
+					"verb": "Uses",
+					"description": "Component reads or writes to this data store"
+				},
+				{
+					"from": "component",
+					"to": "component",
+					"verb": "Contains",
+					"description": "System or module contains this component"
+				}
+			]
+		}
+	},
+	"workshop": {
+		"workspaceConfig": {
+			"paradigm": "developer",
+			"defaultTab": "edit",
+			"defaultView": "tree",
+			"defaultFile": "spec/overview.md",
+			"fallbackFiles": [
+				"README.md"
+			]
+		},
+		"graphGuidance": {
+			"conceptCreation": {
+				"triggers": [
+					"When user defines a component",
+					"When user describes an interface",
+					"When user creates a data model",
+					"When user identifies a dependency"
+				],
+				"typeMapping": {
+					"component": "concept",
+					"interface": "interface",
+					"dataModel": "concept",
+					"service": "concept",
+					"database": "resource"
+				}
+			},
+			"relationshipPatterns": [
+				{
+					"from": "concept",
+					"to": "concept",
+					"verb": "dependsOn",
+					"description": "Component dependency"
+				},
+				{
+					"from": "concept",
+					"to": "interface",
+					"verb": "implements",
+					"description": "Component implements interface"
+				},
+				{
+					"from": "concept",
+					"to": "resource",
+					"verb": "uses",
+					"description": "Component uses database"
+				},
+				{
+					"from": "concept",
+					"to": "concept",
+					"verb": "contains",
+					"description": "System contains component"
+				}
+			],
+			"rules": [
+				"Create concept entities for components",
+				"Track dependencies between components",
+				"Link components to interfaces",
+				"Document data flow relationships"
+			]
+		},
+		"qualityGates": {
+			"fileChecks": [
+				{
+					"path": "technical-spec.md",
+					"required": [
+						"Executive Summary",
+						"Goals",
+						"Architecture",
+						"Data Model",
+						"Security"
+					],
+					"optional": [
+						"Performance",
+						"Scalability",
+						"Deployment"
+					]
+				},
+				{
+					"path": "api-design.md",
+					"required": [
+						"Endpoints"
+					],
+					"optional": [
+						"Authentication",
+						"Error Handling"
+					]
+				}
+			],
+			"projectChecks": [
+				"Executive summary clearly states the problem and solution",
+				"Goals section has measurable success criteria",
+				"Architecture section includes component diagram",
+				"Non-functional requirements have specific targets",
+				"Security section addresses authentication and data protection",
+				"Risks and mitigations are documented"
+			],
+			"exportReady": [
+				"All sections are complete with no TODOs",
+				"Architecture diagrams are included",
+				"Data model is fully specified",
+				"API contracts are defined",
+				"Document has been reviewed and approved"
+			]
+		},
+		"aiPersona": {
+			"role": "You are a senior software architect helping engineering teams write clear, complete technical specifications that guide implementation and enable effective code review.",
+			"expertise": [
+				"Software architecture design",
+				"API contract definition",
+				"Data model design",
+				"Security and threat modeling",
+				"Performance and scalability planning"
+			],
+			"tone": "collaborator"
+		},
+		"exporters": [
+			{
+				"id": "spec-bundle",
+				"name": "Technical Specification Bundle",
+				"description": "Complete specification documents",
+				"icon": "📋",
+				"format": "zip",
+				"category": "document",
+				"handler": "markdown-bundle"
+			}
+		],
+		"difficulty": "advanced",
+		"templateTier": 4,
+		"templateMetadata": {
+			"identifyByStructure": true
+		}
+	},
+	"academy": {
+		"skillPath": "software-architecture",
+		"level": "advanced",
+		"learningObjectives": [
+			"Decompose a system into components with clear responsibilities and well-defined interfaces",
+			"Document API contracts with request/response schemas, error codes, and auth requirements",
+			"Design a data model identifying entities, fields, constraints, and indexing strategy",
+			"Perform a security threat model identifying attack surfaces and mitigations",
+			"Specify non-functional requirements (latency, throughput, availability) with measurable targets"
+		],
+		"assessmentTypes": [
+			"portfolio",
+			"peer-review"
+		],
+		"certificationSlug": "software-architect"
+	}
+} satisfies SoulcraftKitConfig;
+
+export default technicalSpecification;