Agentic coding knowledge map

Core Framework

Agentic coding knowledge becomes useful when environment setup, project conventions, reusable prompts, and post-task lessons stay close to the codebase.

The framework is practical: document only the decisions that affect future work. A good starter note should help another contributor run the project, understand its boundaries, and avoid repeating the same investigation.

When agent workflows change, keep the current procedure in project docs and move historical context into source or study notes.

Docs, Reports, And Retrospectives

Documentation should capture repeated decisions, reports should summarize evidence, and retrospectives should preserve failure modes.¹ Keep the examples small enough for future maintainers to scan.²

This section demonstrates long-form reading behavior. The table of contents should track the section as the reader scrolls, while footnotes remain available as inline annotation points.

Reports should quote evidence sparingly, link back to source material, and leave a clear action for the next person. Retrospectives should describe the trigger signal, the root cause, the corrected approach, and the verification path.

Setup Notes

• Record local prerequisites.
• Keep secret values out of Markdown.
• Prefer project commands over global assumptions.

1. Establish the repo rules.
2. Verify the local command path.
3. Capture the reusable lesson.

Setup notes are most useful when they describe what a new user can run today. Avoid storing machine-specific secrets, personal paths, or stale credentials.

Reusable Patterns

A strong starter repo teaches by example before it asks the user to configure everything.³

Which setup step should be automated first?⁴

Promote patterns only after they appear in more than one task. Until then, keep them as study notes with explicit uncertainty.

Footnotes

1. This footnote is intentionally present so the template demonstrates annotation rendering in long-form notes. ↩

2. Short examples help the reading UI show annotation previews without overwhelming the page. ↩

3. This note is a placeholder for real project-specific agent patterns. ↩

4. Questions stay open until they become repeatable procedures or collected models. ↩