agentleFS
Sign inStart free
frameforgedframeforged/technical-documentation-framework/audience-alignment/SKILL.md

audience-alignment

Skill2 starsChanged 4 months agoApache-2.0View on GitHub

Determines the target audience, technical depth, prior knowledge, tone, terminology policy, and example level for the documentation.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    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:

    Consider one or more of the following:

    line 16
  2. Distinctive:

    Do not write for everyone equally.

    line 64
  3. Distinctive:

    If multiple audiences exist, separate beginner explanation from reference-level detail.

    line 65
  4. Distinctive:

    If the reader is less technical, explain concepts earlier and with examples.

    line 66
  5. Distinctive:

    If the reader is highly technical, still include a glossary but avoid overexplaining common concepts.

    line 67

≈ “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

Audience Alignment Skill

Purpose

Documentation must be written for a specific reader.

A developer guide, an executive overview, an API reference, and an operations runbook require different depth, structure, and terminology.

Audience types

Consider one or more of the following:

  • End user
  • Developer
  • Platform engineer
  • DevOps engineer
  • SRE
  • Solution architect
  • Technical architect
  • Product manager
  • Security engineer
  • Compliance team
  • Operations team
  • New team member
  • Executive or decision-maker

Output format

# Audience Alignment Report

## Primary Audience

## Secondary Audience

## Technical Level

Use a 1-5 scale.

## Expected Prior Knowledge

## Concepts That Must Be Explained

## Concepts That Can Be Assumed

## Tone

## Jargon Policy

## Documentation Depth

## Example Level

## Sections That Need Extra Detail

Rules

  • Do not write for everyone equally. Prioritize the primary audience.
  • If multiple audiences exist, separate beginner explanation from reference-level detail.
  • If the reader is less technical, explain concepts earlier and with examples.
  • If the reader is highly technical, still include a glossary but avoid overexplaining common concepts.
  • Preserve technical terms that are product-specific or industry-standard.

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.

Check your setup, free