Files
openclaw-backups/skills/workspace-review/references/checklist.md
2026-02-17 15:50:53 +00:00

2.5 KiB

Workspace Review Checklist

Quick-reference for periodic audits.

Structure (Required Files)

  • AGENTS.md exists
  • SOUL.md exists
  • USER.md exists
  • IDENTITY.md exists
  • TOOLS.md exists
  • memory/ directory exists

Structure (Optional Files)

  • HEARTBEAT.md — if using heartbeats
  • MEMORY.md — if maintaining long-term memory
  • BOOT.md — if using boot-md hook (runs every gateway restart)
  • BOOTSTRAP.md — one-time first run (delete after)
  • skills/ — if using workspace skills

File Purpose (No Scope Creep)

  • AGENTS.md: Only operating instructions, no memories
  • SOUL.md: Only persona/tone, no tasks or tech details
  • USER.md: Only user info, no agent memories
  • IDENTITY.md: Only identity facts, no philosophy
  • TOOLS.md: Only environment notes, no procedures
  • HEARTBEAT.md: Short checklist only, no full docs
  • MEMORY.md: Curated insights only, no raw logs

File Sizes

  • AGENTS.md < 1000 lines
  • SOUL.md < 200 lines
  • USER.md < 100 lines
  • IDENTITY.md < 50 lines
  • HEARTBEAT.md < 100 lines

Memory Hygiene

  • Daily files use YYYY-MM-DD.md naming
  • Reference docs in memory/ use descriptive names (not dates)
  • No duplicate content between MEMORY.md and daily files
  • Recent daily files reviewed and distilled
  • No API keys or passwords in memory files

Automatic Features (Awareness)

  • Pre-compaction flush: OpenClaw auto-triggers memory save before compaction
  • Heartbeat response: HEARTBEAT_OK stripped when nothing needs attention
  • Empty HEARTBEAT.md: Skipped entirely to save API calls

Vector Search Alignment

  • Only MEMORY.md and memory/**/*.md are indexed by default
  • memorySearch.extraPaths adds other paths if needed
  • memorySearch.experimental.sessionMemory indexes session transcripts if enabled

Git Status

⚠️ Workspace is PRIVATE — never push to GitHub

  • No public remote configured
  • Working tree clean (or intentionally dirty)
  • No untracked files that should be tracked
  • .gitignore excludes secrets
  • No secrets committed

No Rogue Files

  • No README.md duplicating AGENTS.md purpose
  • No NOTES.md or similar duplicates
  • No credentials stored in workspace
  • No files that belong in ~/.openclaw/

Skills (if present)

  • Each skill has SKILL.md
  • Each SKILL.md has name + description frontmatter
  • SKILL.md files are lean (< 500 lines)
  • No duplicate skills vs managed/bundled