Skip to content
Skills Library
Programming · Writing

context-docs

/context-docs

Use when a subsystem needs persistent context for future agents or engineers -- its boundaries keep being rediscovered the hard way, invariants keep getting violated, or sessions repeatedly ask the same questions about it.

Licence
Apache-2.0
Last repository change
27.09.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 27.09.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

Use when a subsystem needs persistent context for future agents or engineers -- its boundaries keep being rediscovered the hard way, invariants keep getting violated, or sessions repeatedly ask the same questions about it.

Original author description

Use when a subsystem needs persistent context for future agents or engineers -- its boundaries keep being rediscovered the hard way, invariants keep getting violated, or sessions repeatedly ask the same questions about it.

How it works

  1. Purpose
  2. When to Use
  3. Inputs
  4. Workflow
  5. Output
  6. Verification
  7. Failure Modes
Original SKILL.md headings · 58 lines, 417 words
SKILL.md preview
---
name: context-docs
description: Use when a subsystem needs persistent context for future agents or engineers -- its boundaries keep being rediscovered the hard way, invariants keep getting violated, or sessions repeatedly ask the same questions about it.
---

## Purpose

Large centralized documentation files consume too much context window. Decentralized, module-specific context docs provide targeted information exactly when an agent needs it.

## When to Use

- A module's boundaries or invariants keep being rediscovered the hard way
- Onboarding or agent sessions repeatedly ask the same questions about a subsystem
- After a refactor changed how a module communicates with the rest of the app

## Inputs

- The subsystem directory and its public interface
- Existing docs, to avoid duplicating the central README or architecture docs

## Workflow

1. **Decide where the context belongs.** Module-specific knowledge goes in a context file *inside* the subsystem directory (e.g., `src/auth/CONTEXT.md`); repo-wide knowledge belongs in the central README or architecture docs — one home per fact, never both:

   ```bash
   find src -iname "CONTEXT.md" -o -iname "README.md"   # existing context docs
   rg -ln "<module name>" docs/                         # already documented centrally?
   ```

2. **Document only the boundaries.** How does this module communicate with the rest of the app? What are its critical invariants? Not implementation detail the code already states.

3. **Keep it terse.** Bullet points and exact file paths. No transient notes — session state, TODO lists, and progress logs belong in handoff documents, not context docs.

4. **Validate every path the doc references:**

   ```bash
   rg -no "src/[A-Za-z0-9_./-]+" src/auth/CONTEXT.md | sort -u   # referenced paths
   test -f src/auth/session.ts && echo OK                        # confirm each exists
   ```

5. **Update these files inline when refactoring the module.** A context doc that lags the refactor is worse than none.

## Output

- A short, boundary-focused context file inside the subsystem directory
- Stale or central-doc-duplicating content removed or relocated

## Verification

- [ ] Doc lives inside the subsystem it describes
- [ ] Content is boundaries and invariants, not implementation detail or transient notes
- [ ] Every referenced file path verified to exist
- [ ] No duplication of central docs — one home per fact
- [ ] Doc updated in the same change set as the refactor that affected it

## Failure Modes

- **Context dumping** — pasting session notes or progress logs into a context doc; that is a handoff, not context.
- **Central duplication** — the same fact in the central README and the module doc, guaranteed to diverge.
- **Path rot** — referenced files moved since the doc was written; validate paths on every touch.
- **Novel-length context** — if it doesn't fit on a screen, agents won't load it when they need it.

Versions

The database has no other skills named context-docs.

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version 803063a0ec03 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100documentation-and-adrs
    Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
  • 100documentation-and-adrs
    Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
  • 100architecture-md-writer
    Write or audit an ARCHITECTURE.md for agents: boundaries, invariants with verify commands, flows and a change guide. Use when creating or updating the architecture doc, or when agent changes keep landing in the wrong place; a UI style spec is the `design-md-writer` skill.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.