Brief logo

Brief

Community
educlopez
brief

Write or update the project's durable design brief at .ui-craft/brief.md. Invoke when the user asks for brief on their UI, or mentions 'brief' alongside design / UI / frontend work.

Overview

Publishereduclopez
Repositoryui-craft
Skill namebrief
Stars
344
Forks
17
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by educlopez on GitHub. Read the source before you install it.

Installation

Install the Brief AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/educlopez/ui-craft.git /tmp/ui-craft
mkdir -p .claude/skills
cp -r /tmp/ui-craft/cli/assets/codex/skills/brief .claude/skills/brief
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Brief in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Brief on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Brief is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Context: this sub-skill is one lens of the broader ui-craft skill. If the ui-craft skill is also installed, read its SKILL.md first for Discovery + Anti-Slop + Craft Test, then apply the specific lens below.

Load references/brief.md for the brief format before proceeding.

Step 1: Detect existing brief

Check whether .ui-craft/brief.md exists. Use Read or ls on .ui-craft/.

If it exists: load its contents. If $ARGUMENTS names a specific update ("update principles", "shift target user", "add out of scope"), focus the session there and skip unchanged sections. Otherwise summarize what's in the brief and ask: "What do you want to change?"

If it doesn't exist: proceed to Step 2. Also check the repo root for a DESIGN.md or design-tokens.json (an ecosystem convention some teams already maintain) — if present, read it and pre-fill the brief's answers from it instead of re-asking; note the source. The brief complements an existing design contract, never contradicts it.

Step 2: Draft a new brief (absent case)

Walk the user through the five required sections in a single pass. Ask ONE compact question per section. Do not open five separate prompts unless the user asks for depth.

Compact prompt template:

"To write your design brief I need five things — answer as tersely as you like, I'll fill in structure:

  1. Product purpose — what does it do, in one sentence?
  2. Primary user — who, by role and context?
  3. Principles — what does this product believe? Give me three to five stances it takes. (If you don't have these yet, say so — I'll run the principles workshop.)
  4. Success metric — what does 'the user succeeded on this surface' look like in observable behavior?
  5. Out of scope — three to five things this surface deliberately does NOT do."

Principles workshop case: if the user says "I don't have principles yet" or gives vague answers ("make it good", "keep it simple"), do NOT fabricate principles from vague input. Load references/principles-catalog.md first. The catalog has 42 worked example principles across 8 product categories — use them as conversation seeds, not as templates to adopt literally. Show 2-3 from the closest category to the user's product, then ask which resonate or which they'd flip. Then run the principles workshop from references/brief.md as a focused sub-flow: ask for three past design decisions that were debated, then derive candidate principles from the patterns. Refuse to accept platitudes — push back and prompt for substance.

Parsing long input: if the user provides a product description or PRD, parse it into the five sections rather than re-asking for information already given. State what you extracted and ask for confirmation or corrections.

Thin answers: if an answer is too vague to constrain a design decision, ask one targeted follow-up. Maximum two follow-ups per section before flagging it as incomplete and moving on.

Step 3: Show before writing

Always show the proposed brief in full before writing the file. Ask: "Does this look right, or anything to adjust?"

Do not write until confirmed.

Step 4: Write the file

Create .ui-craft/ if it doesn't exist. Write the confirmed content to .ui-craft/brief.md.

The file must contain all five sections with the exact headings from references/brief.md. No omissions.

Step 5: After writing

Tell the user the file is at .ui-craft/brief.md. Suggest committing it:

"Commit .ui-craft/brief.md to the repo — it's documentation, not config. The agent reads it every session."

Do not auto-commit. Per project rules, commits require explicit user instruction.

Constraints

  • All five sections are required. If one is genuinely unknown, write it as a dated placeholder with [TO DEFINE — YYYY-MM-DD] so the gap is visible.
  • The brief is append-mostly on updates. Never delete past content — mark deprecated with date and reason.
  • No brand names, product examples, or generic SaaS language inside the user's brief. The brief describes their product, not the template.

Next step: /tokens — the brief decides the intent, the tokens encode it (rung 2).

Frequently asked questions

What does the Brief AI skill do?

Write or update the project's durable design brief at .ui-craft/brief.md. Invoke when the user asks for brief on their UI, or mentions 'brief' alongside design / UI / frontend work.

Why use Brief on TypingMind?

Because you install it once and use it with any model. Brief is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Brief in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/educlopez/ui-craft/tree/main/cli/assets/codex/skills/brief. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Brief?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Brief?

As many as you like. As long as a model supports skills, you can use Brief with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Brief AI skill free?

Yes. It is published on GitHub by educlopez under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇