29 lines
6.9 KiB
Plaintext
29 lines
6.9 KiB
Plaintext
|
<!DOCTYPE html>
|
||
|
|
<html lang="en"><head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Using Workspaces — Unity-Roject-Test</title>
|
||
|
|
<style>
|
||
|
|
@import url('/fonts/barlow.css');
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
<body data-theme="default-roject">
|
||
|
|
<page--header></page--header>
|
||
|
|
|
||
|
|
<page--root data-theme="default-roject">
|
||
|
|
<full--width--block data--page--block="">
|
||
|
|
<full--width--area data--page--area="" contenteditable="true" spellcheck="false" autocorrect="off" autocapitalize="off" style="outline: none;"><h1>Using Workspaces</h1></full--width--area>
|
||
|
|
</full--width--block>
|
||
|
|
<two--columns--block data--page--block="">
|
||
|
|
<two--columns--area data--page--area="" contenteditable="true" spellcheck="false" autocorrect="off" autocapitalize="off" style="outline: none;"><h2>What the Workspace Is</h2><div><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">The </span><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);"><marked-text>workspace</marked-text> folder is the project's memory system, with information, that can be accessed on demand. It has three purposes:</span></div><div><br></div><div><strong></strong><h3><strong>1. Project definition</strong></h3> <span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">A human-readable record of what the project is, what exists, and where it is going. The source of truth about scope and goals.</span></div><div><br></div><div><strong></strong><h3><strong>2. Agent memory</strong></h3><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">The context, rules, and conventions that agents read before doing any work. An agent that reads the workspace can usually start because the bigger context should be clear.</span></div><div><br></div><div><strong></strong><h3><strong>3. Usage documentation</strong></h3><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">The outline, boards, guides and actions explaini how to work with this project and its tools.</span></div><div><br></div><div><br></div><div><marked-text>The workspace describes the features and their reason and understanding.</marked-text> Code shows what was built. The workspace explains what it is, why it exists, and how to work with it.</div></two--columns--area>
|
||
|
|
<two--columns--area data--page--area="" contenteditable="true" spellcheck="false" autocorrect="off" autocapitalize="off" style="outline: none;"><h2>What Goes Where</h2><div><h3><span style="color: rgb(146, 156, 175); font-size: 16px; font-weight: 400; letter-spacing: -0.3px;"><b>index.page</b></span></h3></div><div>Entry point for agents and humans: Project name, a two-sentence description, links to everything else.</div><div><br></div><div><strong>outline</strong> </div><div>Big picture. Scope, goals, what exists now, key technical decisions, what is next. </div><div><br></div><div><strong>boards</strong></div><div>Active work. Organized in kan-ban boards: To-Dos, backlog, bugs.</div><div><br></div><div><strong>guides</strong> </div><div>Rules. Agents must follow guides, they define the workflow, conventions and expectations.</div><div><br></div><div><strong>actions</strong></div><div>Named repeatable procedures. Detailed step-by-step processes for reoccuring agent tasks.</div><div><br></div><div><strong>history</strong></div><div>Session log. What happened each session, what was decided, and why. Usually at the end of every working session.</div><div><br></div><div><div style="color: rgb(146, 156, 175); letter-spacing: -0.3px;"><span style="font-weight: 700;">reference</span></div><div style="color: rgb(146, 156, 175); letter-spacing: -0.3px;">Code doc. For complicated or/and often used code. </div></div><div><br></div></two--columns--area>
|
||
|
|
</two--columns--block>
|
||
|
|
<two--columns--block data--page--block="">
|
||
|
|
<two--columns--area data--page--area="" contenteditable="true" spellcheck="false" autocorrect="off" autocapitalize="off" style="outline: none;"><h2>The Memory Rule</h2><div>Anything a future agent needs to understand or know about the project belongs in the workspace.</div><div><br></div><div>Decisions and their reasons belong in the <strong><marked-text>history</marked-text></strong>. Rules and constraints belong in the <strong><marked-text>guides</marked-text></strong>. Current tasks belong in the <strong><marked-text>boards</marked-text></strong>. The big picture belongs in <strong><marked-text>outline</marked-text></strong>. <span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">For complex or unusual code Implementations, details can be in the </span><b style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);"><marked-text>reference</marked-text></b><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">. </span></div><div><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);"><br></span></div><div><span style="background-color: var(--block--background--color); color: var( --color ); font-family: var( --font--family ); font-size: var( --font--scale ); letter-spacing: calc(-0.3px);">Agents should after a task think about, whether there was unusal information coming up, which would be helpfull for a next session.</span></div></two--columns--area>
|
||
|
|
<two--columns--area data--page--area="" contenteditable="true" spellcheck="false" autocorrect="off" autocapitalize="off" style="outline: none;"><h2>Keeping It Current</h2><div>The workspace is most useful when it is <marked-text>up to date</marked-text>. An outdated outline misleads agents. An empty task board means lost context. A history with no recent entries means nobody knows where things were left.</div><div><br></div><div>Besides, actions, which users can execute to keep organized, agents should actively help keeping things update to date. That usually means <marked-text>to create proposals what should be udpated</marked-text>.</div><div><br></div></two--columns--area>
|
||
|
|
</two--columns--block>
|
||
|
|
</page--root>
|
||
|
|
|
||
|
|
<page--footer></page--footer>
|
||
|
|
|
||
|
|
|
||
|
|
</body></html>
|