Skip to content

Add an explicit memory maintenance and session audit workflow #32

@ssheld

Description

@ssheld

Summary

agent-vault already contains strong session-start and session-end requirements, but the memory-maintenance behavior is spread across several sections and relies heavily on implicit judgment. We should add an explicit, vendor-neutral memory maintenance workflow so generated projects have a clearer process for keeping canonical memory files current.

This is conceptually similar to what Claude's claude-md-management plugin is trying to automate, but here it should remain markdown-first, portable, and repo-local.

Planning Metadata

  • Priority: High
  • Estimated effort: Medium
  • Suggested order: 1 of 4, since this is the most central improvement to the template's core purpose

Why this matters

  • The scaffold tells agents to update many files, but it does not yet provide a compact "memory audit" pass that helps them decide what changed and where it belongs.
  • In practice, the risk is not missing a file entirely; it is writing the right fact to the wrong place, or leaving durable decisions buried in a scratch note or PR conversation.
  • An explicit maintenance workflow would reinforce the distinction between temporary working memory and canonical project memory.
  • This fits the repository's core purpose more directly than most other plugin-derived ideas.

Proposed scope

  • Add a Memory Maintenance or Memory Audit section to scaffold/agent-vault/shared-rules.md.
  • Mirror that guidance into scaffold/agent-vault/AGENTS.md.
  • Define a repeatable end-of-session pass that asks, at minimum:
    • What changed in the code or docs?
    • What durable context should be added to context-log.md?
    • Are there new unresolved items for open-questions.md?
    • Was a durable decision made that needs a decision record and decision-log.md update?
    • Was there a mistake pattern worth recording in lessons.md?
    • Is a handoff note needed?
  • Clarify the intended role of each canonical file versus context/scratchpad.md.
  • Consider whether a lightweight checklist template would help, for example a Session Wrap-Up Checklist or similar reusable note.
  • Update scaffold docs if the workflow materially changes how generated projects are expected to maintain memory.

Candidate files

  • scaffold/agent-vault/shared-rules.md
  • scaffold/agent-vault/AGENTS.md
  • Potentially one new template under scaffold/agent-vault/Templates/
  • scaffold/agent-vault/README.md
  • README.md

Candidate guidance areas

  • How to distinguish temporary notes from durable project memory.
  • How to decide whether information belongs in:
    • context-log.md
    • design-log/
    • daily/
    • open-questions.md
    • decision-log.md and decisions/
    • lessons.md
    • context/handoffs/
  • A short audit sequence to run before finalizing work.
  • Examples of common failure modes:
    • decision buried in a design-log note only
    • open question left in a PR thread instead of open-questions.md
    • scratchpad content never promoted into canonical files
    • handoff state missing despite meaningful unfinished work

Open questions

  • Should this live purely in rules text, or also in a reusable checklist template?
  • Is a lightweight helper script worthwhile, or is that too much automation for the repository's goals?
  • Should the audit language be mandatory for substantive work or presented as strongly recommended guidance?

Non-goals

  • Do not introduce an external database, index, or non-markdown memory store.
  • Do not make agent-vault dependent on a specific model, client, or plugin system.
  • Do not turn this into a general-purpose task tracker; stay focused on project context hygiene.

Success criteria

  • Generated projects have a clear, explicit memory-maintenance pass instead of relying only on scattered requirements.
  • The distinction between temporary notes and canonical memory is easier to follow.
  • The workflow reduces ambiguity about where session outcomes should be recorded.
  • Policy mirrors remain in sync.

Validation ideas

  • bash scripts/check-policy-mirrors.sh
  • If new templates are added, verify they appear correctly in a freshly generated scaffold.

Context

This issue comes from evaluating useful patterns in official Claude Code plugins while keeping agent-vault vendor-neutral. The goal is to capture the useful maintenance workflow in normal project docs rather than through Claude-specific packaging.

Reference inspiration:

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions