---
name: handoff-doc
description: Write a hand-off document so a fresh session or another person can continue the current task without the chat history. Use when switching tasks, after several compactions, before clearing a session, or when asked to write a handoff, brief, or progress doc.
title: handoff-doc
canonical_url: https://skilld.dev/gh/minimax-ai/mcode-stack/handoff-doc
last_updated: 2026-10-29T09:48:02.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install minimax-ai/mcode-stack/handoff-doc`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/handoff-doc`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/minimax-ai/mcode-stack/handoff-doc) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/handoff-doc`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/handoff-doc --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/handoff-doc --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Hand-off Doc

Important state should not live only in the context window. A short, readable
hand-off doc lets you clear the session, start a new one, or pass the work to
someone else, and continue with exactly what you consider important.

Companion to MCode Engineering Notes 01 and 03.

## 1. Gather from real sources

Before writing, check the actual state instead of relying on memory of the
conversation:

- `git status`, `git log` for the branch, and the current diff.
- The test or build commands that were run and their latest real results.
- Any existing design, progress or todo files in the repository.
- Open issues, PRs or review comments linked to the task.

If something cannot be verified, mark it "unverified".

## 2. Write the doc

Save it in the repository (for example `docs/handoff/<task>.md`) or wherever
the project keeps working notes. Ask before committing it. Use this template:

```markdown
# Hand-off: <task>

Updated: <date>   Branch: <branch>   Last commit: <short sha>

## Goal
One or two sentences. What "done" looks like, and the acceptance criteria.

## Decisions made
- <decision> - because <reason>

## Constraints to keep
- <constraint the next session must not break, e.g. "do not change the public API">

## Ruled out
- <approach> - why it was dropped (so nobody tries it again)

## Current state
- Done: ...
- In progress: ...
- Verified by: <command> -> <result>

## Next steps
1. <the very next concrete action>
2. ...

## Watch out for
- Known pitfalls, flaky tests, environment quirks.

## Pointers
- Key files, functions, issues, PRs.
```

Keep it short. It is a brief, not a transcript. Leave out debugging
narratives and tool output that can be reproduced.

## 3. Hand over

- Tell the user where the doc is.
- In the new session, reference the doc first (for example by mentioning its
  path) and ask the agent to restate the goal and the next step before it
  starts.
- Update the same doc at each milestone instead of creating new ones.

## Output

The path of the doc and a three-line summary: goal, current state, next step.
