agentleFS
koomaikoomai/claude-kit/skills/artifact-conventions/SKILL.md

artifact-conventions

Skill4 starsChanged 16 days agoMITView on GitHub

Builds artifacts and standalone HTML pages in the house style, taking the look from the project's DESIGN.md. Use when asked to make, publish, redesign or fix an artifact, HTML page, report, explainer, review, decision page, dashboard or mockup canvas; when a page looks generic, off-brand, like "AI slop" or broken on a phone; or when the reader has to answer decisions and paste the answers back.

4 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions4 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 4

    1. attilaszasz/sdd-pilot★ 98same name
    2. GoogleCloudPlatform/LifeSciences★ 57same name
    3. lebobo88/pair-programmer★ 8same name
    4. terravic/pde-agent-plugin★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository7 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 9

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the first of these that exists, before writing any CSS:

    line 21
  2. Distinctive:

    Keep running text near 65 characters wide.

    line 47
  3. Very specific:

    No horizontal page scroll at 390px.

    line 48
  4. Distinctive:

    Keep diagrams; they carry the page.

    line 107
  5. Distinctive:

    Use the project's own terms for its concepts.

    line 117
  6. Distinctive:

    Never describe the audience's abilities ("non-technical", "for beginners").

    line 119
  7. Very specific:

    Every page that asks the reader for decisions ends with an answerable decisions table.

    line 126
  8. Distinctive:

    Every row also gets an optional comment, and the form ends with "Anything else" and "Copy answers for Claude".

    line 160
  9. Distinctive:

    When the artifact is a canvas of artboards (mockups, screen states):

    line 171
  10. Distinctive:

    Look at the rendered page once, at desktop width and at 390px:

    line 184
  11. Distinctive:

    No horizontal scroll and no console errors.

    line 186
  12. Very specific:

    Every colour, font, size and radius comes from DESIGN.md.

    line 187

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “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

Artifact Conventions

How every artifact and standalone HTML page is built. The look (colours, type, radius, layout style) lives in a separate DESIGN.md; this file holds the rules that apply whatever the look.

Precedence: the user's words in the session, then DESIGN.md, then this file. The structural rules of artifact-design (CSP hosts, <title> naming, content visible at rest) still apply.

1. Load the design

Read the first of these that exists, before writing any CSS:

  1. DESIGN.md at the project root
  2. .claude/DESIGN.md in the project
  3. references/DESIGN.md in this skill's directory, the bundled starter

Take every colour, font, size and radius from it. A value the page needs that DESIGN.md lacks is a gap to raise with the user, not one to fill with an invented value. When the page falls back to the starter, say once that the project can copy it to its root and make it its own.

DESIGN.md decides theme support too: if it defines dark values, build both themes; if it says light only, declare color-scheme: light and add no dark palette.

Required tokens

The decisions-table script styles itself with these CSS variables, so every DESIGN.md defines them on :root: --ground, --surface, --sunken, --line, --line-strong, --ink, --ink-2, --accent, --accent-soft, --on-accent, --radius-sm, --radius-md.

2. Page structure

  • Real h2/h3 headings that name their subject flatly. No slogan headings ("Three locks, one at each level").
  • Tables for comparisons and decisions. A dl for paired facts.
  • One framed figure per illustration.
  • Summary before detail. Body text near 16px; nothing smaller than 13px, SVG labels included.
  • Keep running text near 65 characters wide.
  • No horizontal page scroll at 390px. Only a table, diagram or code block may be wider, inside its own overflow-x: auto box.

3. AI tells to avoid

These mark a page as machine-made at a glance. Adapted from the Impeccable slop catalog.

Never put a side-tab accent border on a card: a thick coloured stripe down one side of a rounded box. It is the most recognisable tell, and it makes an ordinary card look like an alert with nothing to report. A real alert that needs status colour uses a tinted fill or an icon, not a stripe.

Structure:

  • A label, eyebrow or kicker above a heading, and a badge or pill above the main headline.
  • An icon tile stacked above a heading.
  • Grids of identical cards (icon, heading, two lines) that give every point the same weight.
  • Cards inside cards.
  • A hero metric: a huge number with a small label, when the figure isn't the point of the page.
  • Small 01 / 02 / 03 numbers beside headings when the content is not a sequence.

Surfaces:

  • A coloured bar along the top of a rounded card.
  • A hairline border and a wide shadow on the same card. Pick one.
  • Glassmorphism, decorative grid-line backgrounds, repeating stripes.
  • Radial halos or soft spotlights behind content.
  • Gradient text, and gradients generally.
  • The default AI palettes: purple-to-blue gradients, cyan on near-black, cream and terracotta.
  • Very large corner radii on cards.

Type:

  • All-caps body text, crushed letter spacing, wide letter spacing on body text.
  • An oversized italic serif display headline used for an "editorial" look.
  • Flat hierarchy where headings and body text look alike.

Motion:

  • Pulsing status dots, blinking cursors, marquees.
  • Bounce or elastic easing.
  • Hover lifts, and images that zoom or rotate on hover.
  • Content hidden until an entrance animation runs.

Copy:

  • An em dash in every other sentence. Use full stops.
  • Forced contrast ("Not a feature. A platform.") and "not X, but Y" framing.
  • Generic marketing claims ("supercharge", "seamless").
  • The same label repeated in several slots of one container.

Imagery:

  • Placeholder SVG art: avatar blobs, generic circles and blocks, rough mascots.
  • Unicode arrows (→) used as connectors in diagrams. Draw the connector.

4. Diagrams

  • Draw technical diagrams (architecture, flowchart, sequence, state, ER, timeline, swimlane, tree) with the diagram-design:diagram-design skill when it is listed. Skip its style-guide setup gate and give it the DESIGN.md tokens instead of its neutral skin. When it isn't listed, offer the user the install once (claude plugin marketplace add cathrynlavery/diagram-design, then claude plugin install diagram-design@diagram-design, then /reload-plugins) and draw the diagram by hand meanwhile.
  • Keep diagrams; they carry the page. Prefer a clearly labelled illustration to a paragraph when explaining a workflow or a structure.
  • Draw charts to scale: every mark and tick from one scale, every label a value the chart reaches.
  • Below 720px wide, draw a portrait SVG or show a list version. Never give a figure a min-width inside a scroll box.
  • Narrow-screen grids use minmax(0, 1fr). Without it, a pre widens the page.

5. Copy

  • Say each fact once.
  • Use the project's own terms for its concepts. Do not swap in a generic word that reads more smoothly.
  • Never describe the audience's abilities ("non-technical", "for beginners"). Name the document's purpose instead.
  • Explain technical detail in plain language.
  • End with an explicit ask: the decisions table in section 6.

6. Decisions table

Every page that asks the reader for decisions ends with an answerable decisions table. The script scripts/decisions.js in this skill's directory turns the table into a form and adds a copy button; the reader pastes the copied text back to Claude.

Inline the script's contents in a <script> at the end of the page. A src on another host is blocked by the artifact CSP.

<table class="decisions" data-decisions="Search filter usage">
  <thead><tr><th>Decision</th><th>Recommendation</th><th>Status</th></tr></thead>
  <tbody>
    <tr data-decision="guests-bar" data-ask="ok">
      <td>Guests in the search bar</td>
      <td>Move Guests out of the Filters sheet into the search bar.</td>
      <td><span class="pill">Needs your OK</span></td>
    </tr>
  </tbody>
</table>
  • data-decisions names the table in the copied text and keys the saved draft.
  • The last column is the answer column. The script renames its heading "Your answer" and stacks the status pill (.pill, styled by the page) above the controls.
  • data-decision is a short stable id, so a draft survives a republish.
  • data-ask sets the control:
data-askControlUse for
okOK / Not OK radiosEvery "Needs your OK" row. Radios, not a checkbox, so an unanswered row is never read as a rejection.
yesnoYes / No radiosA row phrased as a question.
choice + data-choices="A|B|C"One radio per optionA choice between named options.
textAn always-open textareaA row that needs a written answer.
omittedComment onlyAn information row, such as "No change".

Every row also gets an optional comment, and the form ends with "Anything else" and "Copy answers for Claude". The copied text lists each decision with its recommendation, the answer ("No answer" when blank) and any comment. Answers are kept in the viewer's localStorage as an unsent draft only; nothing reaches Claude until the reader pastes. When the browser blocks the copy, the text appears selected in a textarea for a keyboard copy.

Mark rows that need an answer visibly (a tinted row or a status pill), and say above the table that the reader answers here and pastes the result back.

7. Design-canvas mockups

When the artifact is a canvas of artboards (mockups, screen states):

  • The per-artboard open control is an eye or magnifying-glass icon, never a play button.
  • In the zoomed view, the left and right arrow keys move to the previous or next artboard without returning to the canvas, and ‹ › buttons sit at the left and right screen edges.
  • The zoomed view shows the caption in a bottom-centre pill: title · n / total.
  • Switching artboards never flickers through the canvas. Cover the switch with a slide curtain: a dark full-screen panel slides in from the direction of travel and out the other side.
  • A stock canvas template usually lacks these. Patch the template once per task and seed from the patched copy. Patch it again if the template's skill version changes.

8. Before publishing

Look at the rendered page once, at desktop width and at 390px:

  • No horizontal scroll and no console errors.
  • Every colour, font, size and radius comes from DESIGN.md.
  • None of the tells in section 3.
  • The decisions table answers, copies and keeps its draft across a reload.

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.