{"$schema":"https://soulcraft.com/schemas/kit/v2.json","id":"document","type":"soulcraft","name":"Document","description":"sections a reader will check — a spec, a PRD, an API reference, a design doc","longDescription":"The room for documents a reader checks their work against: an API reference, a technical specification, a product requirements document, or a game design document. Four kits fold in with real intents and placements (API Documentation, Technical Specification, Product Requirements (PRD), Game Design Document); one empty shell (Technical Documentation) contributes only its own description, which already lists this room's four members.","version":"1.0.0","author":{"name":"Soulcraft Labs","email":"kits@soulcraft.com","url":"https://soulcraft.com"},"status":"released","role":"primary","tags":["goal-room","api","documentation","development","technical","specification","architecture","design","product","requirements","game-design","mechanics"],"variables":[{"key":"projectName","label":"Document title","description":"The title of the spec, PRD, API reference, or design doc","type":"string","required":true,"example":"Checkout API Reference"}],"shared":{"industry":"software-development","category":"development","glossary":{"core loop":"The primary repeating cycle of actions a player performs","mechanic":"A specific rule or system that governs player interaction","pillar":"A core design principle that guides all decisions"},"aiExpertise":["API documentation best practices","OpenAPI/Swagger specification","REST endpoint design","Software architecture design","API contract definition","Product requirements writing","User story creation with acceptance criteria","MoSCoW prioritization","Game design principles and patterns","Mechanics and systems design"],"dataModelHints":["concept","document","event","person"],"suggestions":[{"label":"Add an endpoint","prompt":"Help me document a new API endpoint"},{"label":"Generate examples","prompt":"Generate request and response examples for my API endpoints"},{"label":"Write authentication docs","prompt":"Help me write the authentication section of my API documentation"},{"label":"Create error reference","prompt":"Help me create a comprehensive error code reference"},{"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":"Create diagrams","prompt":"Help me create a system diagram for my architecture"},{"label":"Write a user story","prompt":"Help me write a user story with acceptance criteria"},{"label":"Define requirements","prompt":"Help me define functional requirements for a feature"},{"label":"Create wireframe notes","prompt":"Help me describe the UX flow for a feature"},{"label":"Design a game mechanic","prompt":"Help me design and document a new game mechanic"},{"label":"Create a character class","prompt":"Help me create a new character class or archetype"},{"label":"Write a level design","prompt":"Help me write a level design document"},{"label":"Define art direction","prompt":"Help me define the visual art direction for my game"},{"label":"Explore API structure","prompt":"Show me the structure of my API documentation and what's complete"}],"dataModel":{"entities":[{"domain":"endpoint","type":"Concept","description":"An API endpoint with HTTP method, path, and contract — or any structural section of a spec, broken into its own tree node.","products":{"workshop":{"view":"tree"}}},{"domain":"component","type":"Concept","description":"A software component, service, or interface a document describes, and the dependencies between them.","products":{"workshop":{"view":"graph"}}},{"domain":"errorCode","type":"Concept","description":"An error code, stakeholder, or character class named and described by the document.","products":{"workshop":{"view":"gallery"}}},{"domain":"story","type":"Event","description":"A user story with acceptance criteria, or a feature under specification, describing desired behaviour.","products":{"workshop":{"view":"board"}}},{"domain":"metric","type":"Concept","description":"A success metric that defines when a feature or system is working.","products":{"workshop":{"view":"stats"}}}],"relationships":[{"from":"endpoint","to":"component","verb":"References","description":"Endpoint or spec section operates on this component or resource"},{"from":"endpoint","to":"errorCode","verb":"Returns","description":"Endpoint can return this error code"},{"from":"story","to":"component","verb":"Implements","description":"Story or feature implements this component"},{"from":"story","to":"metric","verb":"Measures","description":"Story's success is judged by this metric"}]}},"workshop":{"difficulty":"intermediate","templateTier":4,"workspaceConfig":{"paradigm":"writer","defaultTab":"edit","defaultView":"tree"},"aiPersona":{"role":"You are a technical writing collaborator — an API documentation specialist for endpoint references, a senior software architect for technical specifications, a senior product manager for PRDs, and a game designer for design documents — helping teams write clear, complete documentation a reader can check their work against.","expertise":["API documentation best practices","OpenAPI/Swagger specification","Software architecture design","Data model design","Product requirements writing","User story creation","Feature prioritization","Game design principles","Mechanics and systems balancing"],"tone":"collaborator"}}}