Workspace Archive Workflow

Workspace Archive Workflow

Use this skill to keep project folders readable, reproducible, and easy for another agent to continue.

Core Rules

• Keep exactly one Markdown file per folder, named README.md.
• Append new progress to the existing README.md; do not create new Markdown files for similar work.
• Every README.md must include a clear timestamp section so the user can see when that folder's work was created, run, updated, or archived.
• Put a root README.md in the work directory. It should explain the directory purpose, subfolder contents, current progress, recommended reading order, and reproduction notes.
• Give each child folder its own README.md with the same role: purpose, key files, current status, and how to reproduce or inspect results.
• Keep folder nesting shallow. Prefer no more than three directory levels under the work root.
• Do not create new folders unless needed. If a new folder is needed, ask the user first and state why the existing folders are not enough.
• Before deleting duplicate Markdown files, merge any useful content into the folder README.md.
• After archiving, report how many top-level folders exist and summarize the structure.
• Do not move or delete large binary/model/result files unless the user explicitly asks, or they are clearly temporary duplicates and the reason is documented.
• If a repository or deliverable intentionally uses multiple Markdown files as product documentation, ask before consolidating them.

README Checklist

Each README.md should include only the useful handoff facts:

• folder purpose
• key files and what each group is for
• current status and recommended baseline
• reproduction or inspection steps
• known limitations, risks, or next actions
• a timestamp section, such as ## 时间记录 or ## Timestamp Log

For timestamp sections, include the most useful available times:

• created or archived time
• simulation run time or batch start/end time when known
• last documentation update time
• source timestamps inferred from file names when exact run logs are unavailable
• timezone if it matters; use local time by default

Workflow

1. Inspect the target directory with rg --files or Get-ChildItem.
2. Count Markdown files per folder and identify folders missing README.md.
3. Read existing Markdown files before merging or deleting them.
4. Write or update the root README.md.
5. Write or update child README.md files.
6. Rename the only Markdown file in a folder to README.md when no merge is needed.
7. Remove merged duplicate Markdown files only after their content is preserved.
8. Verify every folder has exactly one README.md.
9. Report the final structure and any files intentionally left untouched.

Merge Policy

• Preserve paths, model names, parameters, solver assumptions, result numbers, and reproduction commands.
• Preserve existing run timestamps and timestamped folder names.
• Compress repeated status prose into one current-status section.
• Keep stale or failed attempts only when they explain why the current baseline was chosen.
• Prefer appending a dated progress note over rewriting the whole README.

Final Report

After cleanup, report:

• root path
• top-level folder count
• files left in the root
• one-line purpose of each top-level folder
• validation result for the one-README-per-folder rule
• any skipped cleanup and why

COMSOL And MATLAB Rule

When a task requires COMSOL and MATLAB LiveLink joint simulation or model solving:

• First confirm COMSOL LiveLink for MATLAB / MATLAB server is already running.
• If it is not running or cannot be reached, stop the simulation task and ask the user to start it manually.
• Do not proceed with COMSOL/MATLAB solve automation until the server is confirmed.
• Documentation-only cleanup can continue without the server.