Best for
- Documenting a module, service, or integration for future reference
- Exploring an unfamiliar area of the codebase
- Preparing for a feature that touches multiple areas
event4u-app/agent-config/src/skills/context-document/SKILL.md
Use when the user says "create context", "document this area", or wants a structured snapshot of a codebase area for agent orientation.
Decision brief
Use when the user says "create context", "document this area", or wants a structured snapshot of a codebase area for agent orientation.
Compatibility matrix
| Platform | Status | Evidence | What to check |
|---|---|---|---|
| Codex | Not declared | No explicit evidence | Portability before use |
| Claude Code | Not declared | No explicit evidence | Portability before use |
| Cursor | Not declared | No explicit evidence | Portability before use |
| Gemini CLI | Not declared | No explicit evidence | Portability before use |
Installation
The source command is displayed only when detected. A safe inspection prompt is always available so your agent can explain every action before execution.
npx skills add https://github.com/event4u-app/agent-config --skill "src/skills/context-document"Inspect the Agent Skill "context-document" from https://github.com/event4u-app/agent-config/blob/0adf49a8ae84b0ff6e2de8759eea43257e020eff/src/skills/context-document/SKILL.md at commit 0adf49a8ae84b0ff6e2de8759eea43257e020eff. List every install step, command, network request, credential, file read/write, external action, and rollback step. Explain whether it fits my task. Do not install or execute anything until I approve.
Workflow
1. Identify scope — Which area of the codebase needs a context document? 2. Research — Use codebase-retrieval to understand the area (files, patterns, dependencies). 3. Write or update — Create/update the context doc following the template below. 4. Verify — Confirm all referenc…
Use this skill when: - Documenting a module, service, or integration for future reference - Exploring an unfamiliar area of the codebase - Preparing for a feature that touches multiple areas - Onboarding to a new part of the codebase
Review the “File structure” section in the pinned source before continuing.
Review the “Context types” section in the pinned source before continuing.
A knowledge card extends this mechanism for the evidence-first discipline; it is not a second system. Unlike a normal context (a present-state snapshot a human curates), a card is governed: it is a cache of expensive remote evidence, never a source of truth and never a build inp…
Permission review
No configured static risk pattern was detected
This is not proof of safety. Runtime behavior, indirect dependencies, and hidden external systems are outside the static scan.
Evidence record
| Signal | Value | Evidence type | Meaning |
|---|---|---|---|
| Quality score | 95/100 | Computed | Documentation, specificity, maintenance, and trust rules |
| Repository stars | 7 | Source | Repository attention, not individual Skill quality |
| Compatibility | 0 platforms | Source | Declared in the catalog source record |
| Usage guide | automated source guide | Editorial | Generated or reviewed according to the visible evidence level |
Pinned source
Use this skill when:
Do NOT use when:
roadmap-management skill)A context document is a structured snapshot of a codebase area:
Unlike feature plans (future-focused) or roadmaps (task-focused), contexts are present-focused — they describe the current state of the code.
.augment/contexts/ # Shared contexts (about the agent system itself)
├── augment-infrastructure.md
├── skills-and-commands.md
└── documentation-hierarchy.md
agents/settings/contexts/ # Project-wide contexts
├── {context-name}.md
{module_root}/{Module}/{agent_folder}/settings/contexts/ # Module-scoped contexts
├── {context-name}.md # Laravel: app/Modules/…
# Symfony: src/Bundle/…
# Monorepo: packages/…
.augment/templates/
└── contexts.md # Context template
| Type | Scope | Example |
|---|---|---|
| Module | Single module's structure and purpose | client-software.md |
| Domain | Business domain across modules | import-pipeline.md |
| Service | Complex service with its dependencies | customer-service.md |
| Integration | External API/system integration | probaus-api.md |
| Infrastructure | DevOps or infrastructure concern | queue-system.md |
| Knowledge card | Trust-tiered cache of expensive (remote) structural evidence — negative facts + pointers durable, positive structure a hypothesis | lodash.md, stripe-api.md |
| Standards card (Class A) | Coding standards derived from real tooling config — pointer + digest, trust: high (config-derived), auto-refreshed when the config changes; never a flattened claim | coding-standards.md (points at ruff.toml, .editorconfig) |
| Lesson card (Class C) | A learned lesson — symptom (fact) split from hypothesis (decaying theory), trust: low, subject-not-person, anti-calcification decay; promoted only via the human gate (accumulation layer is eval-gated) | agents/memory/curated/lessons/<slug>.md |
| Knowledge page (typed) | Team-shared, lifecycle-typed knowledge that grows while working a project — episodic sessions, semantic concepts, procedures on their way to a skill, small decisions | agents/knowledge/concepts/api-response-shape.md |
| Content | Location |
|---|---|
About the .augment/ system itself | .augment/contexts/ (shared package) |
| Project-wide or cross-module | agents/settings/contexts/ |
| Module-specific | {module_root}/{Module}/{agent_folder}/settings/contexts/ (resolved via modules.root_paths + modules.agent_folder; Laravel example: app/Modules/{Module}/agents/settings/contexts/) |
| Knowledge card (committed) | agents/knowledge/<source>.md — fill from the knowledge-card template |
| Knowledge page (typed, committed) | agents/knowledge/{sessions,concepts,procedures,decisions}/<slug>.md — fill from the knowledge-pages template |
| Evidence Report / probe dumps / absence log (ephemeral) | agents/memory/knowledge/session/ (gitignored, overwritten each task) |
| If unsure | Ask the user |
A knowledge card extends this mechanism for the evidence-first discipline; it
is not a second system. Unlike a normal context (a present-state snapshot a
human curates), a card is governed: it is a cache of expensive remote evidence,
never a source of truth and never a build input. Its trusted core is its
negative facts + pointers (trust: durable); its positive structure is a
per-line, last-verified hypothesis that loads as "Assumed (from card)" and
must be re-confirmed against the live source before use. Cards pass the
check_knowledge_cards.ts pointer-CI (size ≤ 150, mandatory authoritative
pointer, trust tagging, multi-evidence consistency). See
source-discovery for when a structure is
card-worthy and evidence-discipline
for the full model.
Alongside knowledge cards, agents/knowledge/{sessions,concepts,procedures,decisions}/
holds team-shared knowledge that grows while working the project —
coding standards observed, module structure, API endpoint shapes, recurring
mistakes, small decisions not big enough for an ADR. Fill new pages from the
knowledge-pages
template.
Retrieval protocol — index-first, then grep, then read. Read
agents/knowledge/INDEX.md first (one line per page, regenerated by
src/scripts/generate_knowledge_index.ts); grep for keywords second; read
the specific file third. Never enumerate every knowledge file directly —
there is no search infrastructure by design.
A standards card is a present-state context whose claims are derived from
the project's real tooling config (.editorconfig, eslint.config.js,
pint.json, pyproject.toml/ruff.toml, commit-lint, CI lint steps). It is
trust: high (config-derived) — high because the config is the truth, not
because the agent believes it. Each standard is a pointer + digest (value +
source: file:key + scope), never a flattened claim; conflicting configs are
surfaced as two pointers, never merged. The digest is regenerated when a
source config's mtime/hash changes (auto-refresh, no human gate — Class A is
deterministic) and is read for heuristics only, never to bypass a fresh
structural read. Build it with the
standards-from-config skill; store under
agents/settings/contexts/.
.augment/contexts/ — Part of the shared package. Describes the agent infrastructure:
how overrides work, what skills/commands exist, the documentation hierarchy.
These are read-only at project level (like all .augment/ content).
agents/settings/contexts/ — Project-specific. Describes the project's business domain:
modules, services, integrations, database architecture.
These are created and maintained per project.
When working in an area that has a context document, load it at session start. The session's Context section can reference it.
Before planning a feature, check if a context document exists for the affected area. It provides the baseline understanding needed for planning.
/module-explore gathers the data needed to create a module context.
/context-create turns that exploration into a persistent document.
When customizing a shared skill or command, read .augment/contexts/override-system.md for the naming conventions and format.
When working on the agent infrastructure itself (skills, commands, rules), check
.augment/contexts/ for existing documentation about the system.
codebase-retrieval, view, and file listing.Last Updated when modifying./context-refactor is the dedicated command for this.| Command | Purpose |
|---|---|
context-create | Analyze an area and create a new context document |
context-refactor | Revisit, update, and extend an existing context |
AGENTS.md — reference it instead.