Claude Md Writer logo

Claude Md Writer

Community
serejaris
claude-md-writer

Use when creating or refactoring CLAUDE.md files - enforces best practices for size, structure, and content organization

Overview

Publisherserejaris
Repositorypersonal-corp-os
Skill nameclaude-md-writer
Stars
232
Forks
26
Bundled files
2
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.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

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

Installation

Install the Claude Md Writer 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.
    https://github.com/serejaris/personal-corp-os/tree/main/skills/claude-md-writer
  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/serejaris/personal-corp-os.git /tmp/personal-corp-os
mkdir -p .claude/skills
cp -r /tmp/personal-corp-os/skills/claude-md-writer .claude/skills/claude-md-writer
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Claude Md Writer 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 Claude Md Writer 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 Claude Md Writer 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.

CLAUDE.md Writer

Creates and refactors CLAUDE.md files following official Anthropic best practices (2025).

Golden Rules

RuleWhy
CLAUDE.md < 200 linesLoads on EVERY request, costs tokens
Rules files < 500 lines eachOfficial recommendation per file
Critical rules FIRSTTop = highest priority
Modular rules → .claude/rules/Conditional loading, organized
Use paths: frontmatterLoad rules only for matching files
No linting rulesUse ESLint/Prettier/Biome instead
Pointers over copiesFiles change, references stay valid

Memory Hierarchy

Claude Code loads memory in this order (higher = higher priority):

PriorityTypeLocation
HighestEnterprise/Library/Application Support/ClaudeCode/CLAUDE.md
↓Project./CLAUDE.md or ./.claude/CLAUDE.md
↓Rules./.claude/rules/*.md (conditional)
↓User~/.claude/CLAUDE.md
LowestLocal./CLAUDE.local.md (gitignored)

Use /memory command to see currently loaded files.

3-Tier Documentation System

Official recommendation for large projects:

TierLocationLoadsTarget
1. FoundationCLAUDE.mdAlways< 200 lines
2. Component.claude/rules/{component}/When working in component< 500 lines
3. FeatureCo-located with codeWhen working on featureAs needed

Example structure:

.claude/
├── CLAUDE.md                 # Tier 1: always loaded
└── rules/
    ├── database.md           # Tier 2: SQL, migrations
    ├── api.md                # Tier 2: API patterns
    └── frontend/             # Tier 2: subdirectory
        ├── components.md     # paths: src/**/*.tsx
        ├── layout.md         # paths: src/pages/**/*.tsx
        └── tokens.md         # paths: **/*.tsx

Structure Template

markdown
# Project Name

One-line description.

## Commands

- `npm run dev` - Development
- `npm run build` - Production
- `npm run test` - Tests

## Architecture

| Path | Purpose |
|------|---------|
| `lib/` | Core logic |
| `app/api/` | API routes |

## Key Patterns

**Pattern Name**: One-line explanation.

## Database (if applicable)

| Table | Key Fields |
|-------|------------|

## Modular Docs

See `.claude/rules/` for:
- `database.md` - queries, schema
- `deploy.md` - deployment

## Tech Stack

One line: Next.js 15, PostgreSQL, TypeScript

Conditional Rules (Path-Specific)

Use YAML frontmatter for file-type-specific rules:

markdown
---
paths: "src/api/**/*.ts"
---

# API Rules

- All endpoints must validate input
- Use standard error format

Glob Patterns

PatternMatches
**/*.tsAll .ts files anywhere
src/**/*All files under src/
*.mdMarkdown in project root
src/components/*.tsxComponents in specific dir

Combining Patterns

yaml
# Multiple extensions
paths: "src/**/*.{ts,tsx}"

# Multiple directories
paths: "{src,lib}/**/*.ts, tests/**/*.test.ts"

Note: Wrap patterns in quotes for YAML safety.

Rules with paths: only load when working with matching files → saves tokens.

Workflow: New Project

  1. Run /init for base CLAUDE.md
  2. Review and trim generated content
  3. Identify critical rules — what breaks if ignored?
  4. Create .claude/rules/ for domain-specific docs
  5. Keep main file < 100 lines

Workflow: Refactor Existing

  1. Count lines — if > 300, must split
  2. Find task-specific content — SQL, debugging, deploy → extract
  3. Create .claude/rules/:
    • database.md - queries, schema, connection
    • deploy.md - deployment process
    • messaging.md - integrations (Telegram, etc.)
  4. Use @file references — don't duplicate
  5. Keep in CLAUDE.md — only what applies to EVERY task

What Goes Where

ContentLocation
Project descriptionCLAUDE.md
Critical constraintsCLAUDE.md (top!)
Quick start (3 commands)CLAUDE.md
Architecture overviewCLAUDE.md
Key patterns (1-liners)CLAUDE.md
SQL queries/schema.claude/rules/database.md
Deployment steps.claude/rules/deploy.md
API documentation.claude/rules/api.md
Git workflow.claude/rules/git.md
Personal preferencesCLAUDE.local.md (gitignored)
Code style rules.eslintrc / biome.json (NOT docs)

Import Syntax

Reference files instead of duplicating:

markdown
@README.md
@docs/architecture.md
@~/.claude/snippets/common.md
  • Relative: @docs/file.md
  • Absolute: @~/path/file.md
  • Max depth: 5 hops

CLAUDE.local.md

Personal project settings (auto-gitignored):

markdown
# My Local Settings

- Prefer verbose output
- Run tests after every change
- My worktree location: .trees/

Common Mistakes

MistakeFix
500+ linesSplit into .claude/rules/
SQL examples inline→ rules/database.md
"Run prettier" rulesUse tool config files
Full API docs→ rules/api.md
Deployment instructions→ rules/deploy.md
Code in CLAUDE.mdUse @file:line references
Negative rules onlyAdd alternatives: "Don't X; use Y instead"

Quality Checklist

Before finishing:

  • CLAUDE.md < 200 lines?
  • Each rules file < 500 lines?
  • Critical rules at top?
  • No task-specific content in main file?
  • No code style rules (use ESLint/Prettier)?
  • .claude/rules/ for domain-specific docs?
  • Subdirectories for components (frontend/, backend/)?
  • paths: frontmatter for conditional loading?
  • @ references instead of duplication?
  • CLAUDE.local.md for personal prefs?

Useful Commands

CommandPurpose
/initGenerate initial CLAUDE.md
/memoryView loaded memory files

Sources

Official:

  • code.claude.com/docs/en/memory (Memory management, paths, globs)
  • anthropic.com/engineering/claude-code-best-practices
  • claude.com/blog/using-claude-md-files

Community:

  • thedocumentation.org/claude-code-development-kit (3-Tier System)
  • claudefa.st/blog/guide/mechanics/rules-directory
  • humanlayer.dev/blog/writing-a-good-claude-md

Updated: Jan 2026

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Claude Md Writer AI skill do?

Use when creating or refactoring CLAUDE.md files - enforces best practices for size, structure, and content organization

Why use Claude Md Writer on TypingMind?

Because you install it once and use it with any model. Claude Md Writer 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 Claude Md Writer in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/serejaris/personal-corp-os/tree/main/skills/claude-md-writer. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Claude Md Writer?

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 Claude Md Writer?

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

Is the Claude Md Writer AI skill free?

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