Build Workspace Docs

CommunityPopular

MoizIbnYousaf

build-workspace-docs

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

Overview

Publisher	MoizIbnYousaf
Repository	`ai-agent-skills`
Skill name	`build-workspace-docs`
Stars	1.1K
Forks	133
Bundled files	Instructions only
License	MIT
Links	Skill source Repository Homepage

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 MoizIbnYousaf on GitHub. Read the source before you install it.

Installation

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

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.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
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.

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/MoizIbnYousaf/ai-agent-skills.git /tmp/ai-agent-skills
mkdir -p .claude/skills
cp -r /tmp/ai-agent-skills/skills/build-workspace-docs .claude/skills/build-workspace-docs

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Build Workspace Docs 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 Build Workspace Docs 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 Build Workspace Docs 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.

Build Workspace Docs

Goal

Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.

Guardrails

Always use --dry-run before regenerating docs to preview what will change.
Only run from inside an initialized library workspace (a directory with .ai-agent-skills/config.json).
Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them.
Use --format json to capture structured results for automation pipelines.

Workflow

Preview what would change.

bash
npx ai-agent-skills build-docs --dry-run

Regenerate the docs.

bash
npx ai-agent-skills build-docs

Verify the output.

bash
npx ai-agent-skills build-docs --dry-run --format json

The JSON output includes currentlyInSync to tell you whether docs were already up to date.

When to Run

After add, catalog, vendor, or curate commands that change the skills catalog.
After bulk imports from a remote library.
Before committing workspace changes to git.

Gotchas

Running outside a workspace will fail with a clear error. Use init-library to create one first.
The generated docs use HTML comment markers () as boundaries. Do not remove these markers from the template sections.

Frequently asked questions

What does the Build Workspace Docs AI skill do?

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

Why use Build Workspace Docs on TypingMind?

Because you install it once and use it with any model. Build Workspace Docs 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 Build Workspace Docs in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/MoizIbnYousaf/ai-agent-skills/tree/main/skills/build-workspace-docs. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Build Workspace Docs?

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 Build Workspace Docs?

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

Is the Build Workspace Docs AI skill free?

Yes. It is published on GitHub by MoizIbnYousaf 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

Tdd

mattpocock

CommunityPopular

Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

To Spec

Turn the current conversation into a spec and publish it to the project issue tracker: no interview, just synthesis of what you've already discussed.

To Tickets

Break a plan, spec, or the current conversation into a set of tracer-bullet tickets, each declaring its blocking edges, published to the configured tracker (edges as text in one file per ticket…

Triage

Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Build Workspace Docs

Goal

Guardrails

Workflow

When to Run

Gotchas

Frequently asked questions

Related AI Skills

Set up your own AI workspace now