agentleFS
frameforgedframeforged/technical-documentation-framework/knowledge-mapping/SKILL.md

knowledge-mapping

Skill2 starsChanged 4 months agoApache-2.0View on GitHub

Maps concepts, components, flows, APIs, SDKs, configuration areas, security controls, operations, observability points, and failure scenarios.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep this phase structured.

    line 63
  2. Distinctive:

    Prefer tables for component and configuration mapping.

    line 64
  3. Distinctive:

    Do not introduce architecture that the user did not provide unless explicitly creating a proposed design.

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Knowledge Mapping Skill

Purpose

Turn product information into structured technical knowledge that can be used to write documentation.

Output format

# Knowledge Map

## Core Concepts

## Component Map

| Component | Responsibility | Inputs | Outputs | Dependencies | Notes |
|---|---|---|---|---|---|

## Main User Flows

## Runtime Flows

## Data Flows

## API Surface

## SDK Surface

## Configuration Areas

## Integration Points

## Security Controls

## Operational Concerns

## Observability Points

## Failure Scenarios

## Known Unknowns

Required thinking

For every major component, identify:

  • Its responsibility
  • Its input
  • Its output
  • Its dependencies
  • Its configuration
  • Its failure modes
  • Its observability signals

Rules

  • Keep this phase structured.
  • Prefer tables for component and configuration mapping.
  • Mark uncertainty clearly.
  • Do not introduce architecture that the user did not provide unless explicitly creating a proposed design.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.