{"$schema":"https://soulcraft.com/schemas/kit/v2.json","id":"technical-specification","type":"soulcraft","role":"primary","status":"released","name":"Technical Specification","description":"Detailed technical specification document for software projects","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.","version":"1.0.0","author":{"name":"Soulcraft Labs","email":"kits@soulcraft.com","url":"https://soulcraft.com"},"icon":"🏗️","tags":["technical","specification","architecture","design"],"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"],"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"}]},"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"}]},"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"],"mode":"certification","tutorPersona":{"inheritsFrom":"workshop.aiPersona","method":"socratic","encouragementLevel":"neutral","flashcardsEnabled":true},"certification":{"requiresHumanCertifier":false,"aiCertifierAllowed":true,"lineageEnabled":true,"certificationSlug":"software-architect"},"gamification":{"enabled":true,"achievements":["deep-thinker","completionist","chain-maker"],"streaks":false,"leaderboard":true}},"workshop":{"difficulty":"advanced","templateTier":4,"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"},"workspaceConfig":{"paradigm":"developer","defaultTab":"edit","defaultView":"tree","defaultFile":"spec/overview.md","fallbackFiles":["README.md"],"layout":{"leftDock":"files","rightDock":"properties"},"onboarding":{"showGuide":true,"highlightFeatures":["tree","ai-chat"],"suggestedActions":["Start with the overview document","Define your architecture in architecture.md","Document API endpoints systematically","Ask AI for security considerations"]}},"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"]},"exporters":[{"id":"spec-bundle","name":"Technical Specification Bundle","description":"Complete specification documents","icon":"📋","format":"zip","category":"document","handler":"markdown-bundle","options":{"includeFiles":["**/*.md"],"preserveStructure":true,"addReadme":true}}],"templateMetadata":{"identifyByStructure":true}},"venue":{"bookingNumberPrefix":"TS","subdomainPrefix":"techspec","features":{"cms":true,"customerAccounts":true,"documents":true,"website":true,"notifications":true,"analytics":true,"blog":false,"giftCards":false,"pos":false,"subscriptions":false,"loyalty":false,"waivers":false,"animals":false,"adoption":false,"memories":false,"partners":false,"franchise":false},"fees":{"billingModel":"per-transaction","feeMode":"online-only"},"theme":{"primary":"oklch(0.35 0.12 235)","bgBase":"oklch(0.99 0.005 235)","accent":"oklch(0.55 0.18 185)","textPrimary":"oklch(0.18 0.03 235)","displayFont":"JetBrains Mono","bodyFont":"Inter"},"experienceTypes":[{"slug":"architecture-review","name":"Architecture Review","description":"A 2-hour technical review of your system architecture, API design, or data model. Receive written feedback on scalability, security, and maintainability with concrete recommendations.","priceInCents":55000,"durationMinutes":120,"minGuests":1,"maxGuests":4,"requiresWaiver":false,"isCombo":false,"sortOrder":0,"color":"oklch(0.48 0.14 235)","sessionAttributeDefinitions":[{"key":"reviewScope","label":"Review Scope","type":"select","perGuest":false,"required":true,"options":["System architecture","API design","Data model","Database schema","Full-stack review"]},{"key":"techStack","label":"Tech Stack","type":"text","perGuest":false,"required":false}]},{"slug":"spec-writing-session","name":"Spec Writing Session","description":"A 90-minute collaborative session to draft or refine a technical specification document. Covers requirements, edge cases, interface contracts, and implementation notes.","priceInCents":30000,"durationMinutes":90,"minGuests":1,"maxGuests":3,"requiresWaiver":false,"isCombo":false,"sortOrder":1,"color":"oklch(0.50 0.16 185)","sessionAttributeDefinitions":[{"key":"specType","label":"Spec Type","type":"select","perGuest":false,"required":false,"options":["Feature specification","API specification","System design doc","Data model spec","Integration guide"]}]}],"staffRoles":[{"id":"solutions-architect","label":"Solutions Architect","defaultCapabilities":["checkin","pos","cms","analytics"]},{"id":"tech-writer","label":"Technical Writer","defaultCapabilities":["cms"]}],"chatSuggestions":[{"label":"Review my architecture","message":"I'd like a technical review of my system architecture. How does that work?","emoji":"🏗️"},{"label":"Write a spec","message":"I need help writing a technical specification. Can I book a session?","emoji":"📝"},{"label":"API design help","message":"I'm designing an API and need expert guidance on the interface contract.","emoji":"🔌"},{"label":"Documentation audit","message":"My technical documentation is outdated and inconsistent. Can you help?","emoji":"🔍"}]},"previewImageUrl":"kits/technical-specification/images/preview.webp"}