Brings task.md, changelog.md, and files.md back in sync with what the code says shipped. Reads git history and the working tree, never memory, and refuses to log features it cannot see in source. Use when a feature or fix lands, when the user says "update the docs", "sync changelog", "update files.md", "@update", or when task.md and the code disagree.
中文简介正在准备中。当前显示原文说明。
查看安装方法安装前可以查看交给 AI 代理的指令内容。
Three files describe a project to the next person who opens it. Keep them true.
| File | Answers |
|---|---|
task.md | What is planned, in flight, and done |
changelog.md | What changed for users, by version and date |
files.md | What each file is for |
Truth comes from the repo, not from the conversation. If the diff does not show it, it did not ship.
git rev-parse --show-toplevel, or the workspace root without git.git log --date=short -n 20, git status --short, git diff --stat, and for the current change git diff HEAD --stat or the staged diff. See references/evidence-rules.md for what counts.Sections: ## To Do, ## In Progress, ## Completed.
- [x] YYYY-MM-DD HH:mm UTC <what>. <PRD path if any>. <files touched>. Verified: <command or outcome>.task.md does not exist, create it with the three headings and the current change under Completed or In Progress based on the evidence.Keep a Changelog format. ## [Unreleased] at the top, then ## [x.y.z] - YYYY-MM-DD blocks, each with ### Added, ### Changed, ### Fixed, ### Removed as needed.
git log --date=short. The release date is the date of the commit that bumped the version, or today's UTC date if it has not been committed yet. Never a placeholder, never a future month.package.json with no matching heading, add the heading.One line per file that matters. Grouped by folder.
## convex/
- `schema.ts` tables and indexes
- `stats.ts` heartbeat mutation with 10s dedup window, page view inserts
## src/hooks/
- `usePageTracking.ts` sends heartbeats, debounced 5s, path change aware
node_modules, _generated, lockfiles, build output, and assets unless they are hand written.When the repo has a convex/ folder, the changelog and files.md can name Convex features, but only ones the source proves. references/convex-detection.md lists what file shows what.
Short version:
convex/convex.config.ts registers it. A dependency in package.json is not proof.convex/crons.ts exists and registers a job.convex/http.ts has a route.convex/auth.config.ts or an auth component is present.Prefer none over an invented value.
changelog.md and files.md are often public. Treat them that way.
.env, .env.local, or any secret store to fill in a doc. Env var names are fine to mention. Values never.[redacted] and say so in one line.task.md, changelog.md, files.md, and PRDs the user points at. Nothing else unless asked.Synced project docs.
changelog.md added 2.1.0 (2026-09-15): 3 added, 1 fixed
files.md added 2 files, updated 1 description
task.md moved 1 item to Completed, 1 still In Progress (verification pending: e2e)
Suggested commit: docs: sync changelog, files, and tasks for 2.1.0
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Keeps a change scoped to what was asked. Flags extra features, refactors, and 'while we are here' edits, and moves them to a suggestions list instead of the diff. Use when a request is small and the agent is about to expand it, when a PRD grows beyond its problem statement, or when the user says 'just do what I asked'.
中文简介正在准备中。当前显示原文说明。
Routes Convex work to the right builder skill and covers the handful of rules that apply everywhere: validators on every function, withIndex over filter, idempotent mutations, internal functions for scheduling. Use when a task mentions Convex and no more specific skill matches, or as the first stop before picking one.
中文简介正在准备中。当前显示原文说明。
Builds AI agents on the Convex agent component: threads, messages, tools that call queries and mutations, streaming, RAG with vector search, and workflows for multi step jobs. Use when adding a chat assistant, tool calling agent, or retrieval feature to a Convex app.
中文简介正在准备中。当前显示原文说明。
Production patterns for Convex apps and the rules the @convex-dev/eslint-plugin enforces: validators, indexes, idempotent mutations, avoiding OCC conflicts, thin function wrappers, error handling. Use when reviewing Convex code, asking whether a pattern is right, setting up ESLint, or fixing write conflicts and slow queries.
中文简介正在准备中。当前显示原文说明。
Creates reusable Convex components with defineComponent, a clean client wrapper, their own schema, and an npm publish setup. Use when extracting a feature into a package, building something for the Convex component directory, or when a component's functions are not showing up in the parent app.
中文简介正在准备中。当前显示原文说明。
Schedules work in Convex: cron jobs in convex/crons.ts, one off scheduled functions with runAfter and runAt, batching large jobs, and cancelling or inspecting the queue. Use when something needs to run on a timer, later, or in the background, or when a cron is not firing.
中文简介正在准备中。当前显示原文说明。