project-memory
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseProject Memory
项目记忆
Create or refresh a repository's lightweight memory layer without polluting default context.
This skill owns project documentation memory. It does not own global setup or Architect methodology setup. Use for those setup tasks.
AGENTS.md$setup-ashieslashy-skills创建或刷新仓库的轻量级记忆层,避免污染默认上下文。
本Skill负责项目文档记忆。它不负责全局的设置或架构师方法设置。如需完成这些设置任务,请使用。
AGENTS.md$setup-ashieslashy-skillsBaseline Shape
基线结构
Expected memory set:
- : concise repo-local guardrails only; no runtime flow, status history, release process, environment catalog, or architecture overview.
AGENTS.md - : entrypoint and source-of-truth map.
docs/00-START-HERE.md - : stable project map, architecture, key directories, commands.
docs/01-repo-overview.md - : current behavior, recent changes, risks, validation.
docs/02-current-status.md - : milestones, priorities, deferred work, sequencing.
docs/03-roadmap.md - : practical pickup list.
docs/04-next-steps.md - : hint directory; add ADRs only for durable choices with tradeoffs.
docs/adr/ - : hint directory; add temporary handoff, investigation, or plan files only when useful.
docs/ai/
Copy and adapt templates from when creating missing files. Treat them as starting points, not boilerplate to leave untouched.
assets/templates/Keep short; the full baseline and authoring rules live here.
assets/snippets/project-memory-methodology.md预期的记忆文档集合:
- :仅包含简洁的仓库本地约束规则;不包含运行时流程、状态历史、发布流程、环境目录或架构概述。
AGENTS.md - :入口文档和事实来源映射。
docs/00-START-HERE.md - :稳定的项目地图、架构、关键目录、命令说明。
docs/01-repo-overview.md - :当前行为、近期变更、风险、验证情况。
docs/02-current-status.md - :里程碑、优先级、延期工作、执行顺序。
docs/03-roadmap.md - :实用的后续任务清单。
docs/04-next-steps.md - :提示目录;仅为具有权衡取舍的持久化决策添加ADR文档。
docs/adr/ - :提示目录;仅在有用时添加临时交接、调查或计划文件。
docs/ai/
创建缺失文件时,请复制并改编中的模板。将它们视为起点,而非无需修改的样板文件。
assets/templates/保持简洁;完整的基线和编写规则在此处。
assets/snippets/project-memory-methodology.mdProgressive Disclosure
渐进式披露
- Keep generated and the methodology snippet lean: point to memory, do not embed the whole system.
AGENTS.md - Keep baseline, setup mechanics, and refresh rules here, loaded only when runs.
$project-memory - Use as the map, then open only docs needed for the task.
docs/00-START-HERE.md - Link instead of duplicating architecture, runtime flow, commands, release process, or status.
- 保持生成的和方法学片段精简:指向记忆文档,不要嵌入整个体系。
AGENTS.md - 将基线、设置机制和刷新规则保存在此处,仅在运行时加载。
$project-memory - 使用作为地图,仅打开任务所需的文档。
docs/00-START-HERE.md - 采用链接而非复制的方式处理架构、运行时流程、命令、发布流程或状态相关内容。
Setup or Refresh Workflow
设置或刷新工作流
Use this for missing memory or stale, incomplete, placeholder-heavy docs.
- Read any existing root ,
AGENTS.md, baseline docs, and nearby domain/architecture docs before writing.docs/00-START-HERE.md - Inspect repo shape with , manifests, deployment/config files, tests, scripts, recent work, validation signals, and user context.
rg --files - Preserve useful existing doc structure and voice. Avoid broad rewrites when targeted updates will do.
- Keep each doc short and link to deeper docs instead of duplicating detail.
- Put durable project truth in ; put temporary investigation notes and draft plans in
docs/.docs/ai/ - Never overwrite existing docs unread. Explain substantial structural moves first.
For setup:
- Create only the missing baseline files and hint directories.
- Preserve existing doc style and naming when useful.
- Copy templates from , replace placeholders with discovered repo facts, and delete sections that do not apply.
assets/templates/
For refresh:
- Do not treat existing files as a no-op by default.
- Distinguish stale from still-accurate content before changing it.
- Replace stale facts and placeholders with discovered facts.
- If information cannot be discovered, write a dated unknown such as "Not identified from repo scan on YYYY-MM-DD" only when keeping the section is still useful.
- Update and
docs/02-current-status.mdfirst after substantial work; update overview, roadmap, ADRs, ordocs/04-next-steps.mdonly when facts changed.docs/ai/ - Summarize semantic changes, validation run or skipped, and remaining unknowns before writing.
If noticed during unrelated work, do not derail the task; briefly offer to run setup later.
适用于记忆文档缺失或文档过期、不完整、占位符过多的情况。
- 在编写前,先阅读现有根目录下的、
AGENTS.md、基线文档以及附近的领域/架构文档。docs/00-START-HERE.md - 使用、清单文件、部署/配置文件、测试、脚本、近期工作内容、验证信号和用户上下文检查仓库结构。
rg --files - 保留有用的现有文档结构和风格。如果针对性更新即可解决问题,避免大范围重写。
- 保持每个文档简洁,通过链接指向更详细的文档而非复制细节。
- 将持久化的项目事实放在目录下;将临时调查笔记和计划草稿放在
docs/目录下。docs/ai/ - 切勿未阅读就覆盖现有文档。如需进行重大结构调整,请先说明。
设置流程:
- 仅创建缺失的基线文件和提示目录。
- 如有必要,保留现有文档的风格和命名方式。
- 从复制模板,用发现的仓库事实替换占位符,并删除不适用的章节。
assets/templates/
刷新流程:
- 默认情况下,不要将现有文件视为无需处理的内容。
- 在修改前区分过期内容和仍准确的内容。
- 用发现的事实替换过期内容和占位符。
- 如果无法获取信息,仅在保留该章节仍有用的情况下,标注日期未知,例如“2024-MM-DD仓库扫描未识别”。
- 完成重大工作后,优先更新和
docs/02-current-status.md;仅当事实发生变化时,才更新概述、路线图、ADR或docs/04-next-steps.md中的内容。docs/ai/ - 在编写前,总结语义变更、已执行或跳过的验证以及剩余的未知内容。
如果在无关工作中发现问题,不要偏离当前任务;可简要提出之后运行设置流程的建议。
AGENTS.md Boundary
AGENTS.md边界
AGENTS.md- If root is missing during project-memory setup, propose a concise repo-local file from
AGENTS.mdand renderassets/templates/AGENTS.mdfrom{{PROJECT_MEMORY_METHODOLOGY}}.assets/snippets/project-memory-methodology.md - If root exists and mixes agent guardrails with durable project facts, treat that as documentation drift. Propose moving durable facts into the smallest appropriate
AGENTS.mdfile and rewritingdocs/as lean guardrails.AGENTS.md - Keep guardrails short and actionable: usually 5-10 bullets, one or two lines each. If a guardrail needs background, examples, runtime flow, or operational procedure, put the explanation in and link or point to it from
docs/.AGENTS.md - Keep only constraints that should shape agent behavior before or while reading project docs: safety rules, approval boundaries, validation expectations, repository-specific hazards, and pointers into the docs memory set.
- Do not preserve runtime flow, environment variable catalogs, release procedure, architecture overview, current status, roadmap, or long maintenance notes in merely because they already exist there.
AGENTS.md - Architect methodology adoption still belongs to ; use that skill when the user wants to install or refresh Ashie-owned methodology blocks.
$setup-ashieslashy-skills - When adding project-memory guidance, use between its BEGIN/END markers.
assets/snippets/project-memory-methodology.md - Show a semantic summary and diff/full file before writing any change, and write only after explicit approval.
AGENTS.md
AGENTS.md- 如果在项目记忆设置期间根目录下缺少,请从
AGENTS.md生成一份简洁的仓库本地文件,并从assets/templates/AGENTS.md中渲染assets/snippets/project-memory-methodology.md内容。{{PROJECT_MEMORY_METHODOLOGY}} - 如果根目录下的已存在,且混合了Agent约束规则和持久化项目事实,视为文档漂移。建议将持久化事实移至最合适的
AGENTS.md目录下的文件中,并将docs/重写为精简的约束规则。AGENTS.md - 保持约束规则简洁且可执行:通常为5-10个项目符号,每个1-2行。如果约束规则需要背景信息、示例、运行时流程或操作步骤,请将说明放在目录下,并从
docs/链接或指向该说明。AGENTS.md - 仅保留在读取项目文档之前或期间应影响Agent行为的约束:安全规则、审批边界、验证预期、仓库特定风险以及指向文档记忆集合的指针。
- 不要仅仅因为内容已存在于中,就保留运行时流程、环境变量目录、发布流程、架构概述、当前状态、路线图或冗长的维护说明。
AGENTS.md - 架构师方法的采用仍属于的职责;当用户想要安装或刷新Ashie所属的方法模块时,请使用该Skill。
$setup-ashieslashy-skills - 添加项目记忆指南时,请使用中BEGIN/END标记之间的内容。
assets/snippets/project-memory-methodology.md - 在修改之前,展示语义摘要和差异/完整文件,并仅在获得明确批准后再进行编写。
AGENTS.md
Update Workflow
更新工作流
After substantial work, update the smallest relevant docs:
- Update when behavior, deployment state, known risks, or validation state changes.
docs/02-current-status.md - Update when the next operator/agent action changes.
docs/04-next-steps.md - Update when architecture, directory ownership, or core workflows change.
docs/01-repo-overview.md - Update when priority or sequencing changes.
docs/03-roadmap.md - Add an ADR only for durable decisions with meaningful tradeoffs.
- Promote lasting findings from into canonical docs; prune or mark temporary notes as superseded.
docs/ai/
Do not paste chat transcripts. Summarize outcomes, decisions, commands, and verification signals in current-state language. Use concrete dates when recording status.
完成重大工作后,更新最小范围的相关文档:
- 当行为、部署状态、已知风险或验证状态发生变化时,更新。
docs/02-current-status.md - 当下一个操作员/Agent操作发生变化时,更新。
docs/04-next-steps.md - 当架构、目录归属或核心工作流发生变化时,更新。
docs/01-repo-overview.md - 当优先级或执行顺序发生变化时,更新。
docs/03-roadmap.md - 仅为具有重大权衡取舍的持久化决策添加ADR文档。
- 将中的持久化发现提升为标准文档;删除或标记临时笔记为已过时。
docs/ai/
请勿粘贴聊天记录。用当前状态的语言总结成果、决策、命令和验证信号。记录状态时使用具体日期。
Writing Rules
编写规则
- Optimize for fast pickup by a future human or agent.
- Prefer bullets, links, and short sections over narrative.
- Record "what is true now" and "what to do next"; avoid historical archaeology unless it explains current constraints.
- Keep secrets, token paths, and sensitive environment dumps out of docs.
- Make validation explicit: command run, result, date, and any gaps.
- When uncertain, mark assumptions and open questions plainly.
- 为未来的人类或Agent快速接手进行优化。
- 优先使用项目符号、链接和短章节,而非叙述性文本。
- 记录“当前真实情况”和“下一步行动”;除非能解释当前约束,否则避免历史追溯。
- 不要在文档中包含机密信息、令牌路径或敏感环境配置内容。
- 明确验证信息:运行的命令、结果、日期以及任何空白点。
- 如有不确定,清晰标记假设和未解决的问题。
Template Use
模板使用
Templates live at:
assets/templates/AGENTS.mdassets/templates/docs/00-START-HERE.mdassets/templates/docs/01-repo-overview.mdassets/templates/docs/02-current-status.mdassets/templates/docs/03-roadmap.mdassets/templates/docs/04-next-steps.md- when a handoff note is useful
assets/templates/docs/ai/HANDOFF.md - when an ADR is useful
assets/templates/docs/adr/0001-record-architecture-decisions.md assets/snippets/project-memory-methodology.md
When using templates, replace placeholders with repo-specific facts discovered from files and render snippet placeholders from their canonical snippet files. Delete sections that do not apply. Before proposing generated docs, check the proposed and content for unresolved placeholders and either resolve them, remove the section, or mark a dated unknown.
AGENTS.mddocs/TODO模板位于:
assets/templates/AGENTS.mdassets/templates/docs/00-START-HERE.mdassets/templates/docs/01-repo-overview.mdassets/templates/docs/02-current-status.mdassets/templates/docs/03-roadmap.mdassets/templates/docs/04-next-steps.md- 当需要交接笔记时,使用
assets/templates/docs/ai/HANDOFF.md - 当需要ADR文档时,使用
assets/templates/docs/adr/0001-record-architecture-decisions.md assets/snippets/project-memory-methodology.md
使用模板时,用从文件中发现的仓库特定事实替换占位符,并从标准片段文件中渲染片段占位符。删除不适用的章节。在提交生成的文档之前,检查拟议的和内容中是否有未解决的占位符,要么解决它们,要么删除该章节,要么标注日期未知。
AGENTS.mddocs/TODO