← 返回
AI智能

Workspace Project Standard

Project workspace setup and documentation standard for OpenClaw agents. Enforces a three-layer documentation system and self-contained project structure. Tri...
OpenClaw代理的项目工作区设置与文档规范。实施三层文档体系和自包含项目结构。
lnshyo
AI智能 clawhub v1.0.1 1 版本 100000 Key: 无需
★ 0
Stars
📥 850
下载
💾 15
安装
1
版本
#latest

概述

Workspace Project Standard

Enforce a self-contained project structure with three-layer documentation.

Directory Rules

DirectoryContainsNever contains
-------------------------------------
workspace//Code, scripts, configNotes, AI records
workspace//tmp/Temp files, experimentsLong-term files
workspace/projects//AI records (md only)Code, scripts
workspace/ rootSystem files onlyProject files

Principle: projects are self-contained. All output stays inside workspace//.

Starting a New Project

Run the scaffold script, then fill in the templates:

# Creates full directory structure in one command
scripts/new-project.ps1 -Name "<project-name>"

Then:

  1. Fill in projects//.md using assets/project-template.md
  2. Fill in projects//LINKS.md using assets/links-template.md
  3. Add one row to MEMORY.md project table
  4. Add workspace// to root whitelist in AGENTS.md

Three-Layer Documentation

Layer 1 — MEMORY.md (one-line summary per project)

| 🚧 | <name> | `projects/<name>/` | <description> |

Update when a major capability is added.

Layer 2 — projects//.md (project master doc)

Required sections: ## 当前进展 ## 关键信息 ## 关键文件路径 ## 文档归档 ## 待用户输入 ## 历史记录

Layer 3 — projects//LINKS.md (links & paths index)

Required: all online URLs, local file tree, credentials reference, run parameters, common commands.

See assets/project-template.md and assets/links-template.md for fill-in templates.

Update Triggers

EventUpdate
---------------
New service / API connectedLayer 2 关键信息 + Layer 3
New file createdLayer 2 关键文件路径 + Layer 3
Major feature completeLayer 1 + Layer 2 进展 + 历史记录
Path / config changedLayer 2 + Layer 3 in sync

Workspace Root Whitelist

Only these may exist in workspace/ root:

System files: AGENTS.md SOUL.md MEMORY.md CREDENTIALS.md HEARTBEAT.md SESSION-STATE.md IDENTITY.md USER.md CODING-PERSONA.md TOOLS.md .env package.json package-lock.json

System dirs: memory/ projects/ scripts/ backups/ captures/ config-backups/ tmp/ skills/ node_modules/ .agents/ .clawhub/ .openclaw/ .pi/

Any file not on this list → move to its project's tmp/ immediately.

版本历史

共 1 个版本

  • v1.0.1 当前
    2026-03-29 19:24 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

ai-intelligence

self-improving agent

pskoett
捕获经验教训、错误和纠正,以实现持续改进。使用时机:(1)命令或操作意外失败;(2)用户纠正……
★ 4,055 📥 795,999
ai-intelligence

Self-Improving + Proactive Agent

ivangdavila
自我反思+自我批评+自我学习+自组织记忆。智能体评估自身工作、发现错误并持续改进。
★ 1,349 📥 317,700
ai-intelligence

ontology

oswalpalash
类型化知识图谱,用于结构化智能体记忆与可组合技能。支持创建/查询实体(人员、项目、任务、事件、文档)及关联...
★ 709 📥 243,531