Skip to main content
skill CX Codex

skill-writing-best-practices — Claude Code skill: how to install

skill-writing-best-practices provides guidelines and structural patterns for authoring AI agent skills. Useful when packaging codebase conventions or reviewing rules in skills/.

MIT 176 installs ★ 92 updated 2026-02-01

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add sergiodxa/agent-skills --skill skill-writing-best-practices -a claude-code
Open on GitHub

What skill-writing-best-practices does

This skill defines six core rules for building AI agent guidelines, grouped into structure, content, and writing style. The assistant triggers these checks whenever you create or edit files in the skills/ directory.

The specification divides each skill into a main SKILL.md summary and a dedicated rules/ folder containing granular files. Every individual rule must include frontmatter, rationale, and explicit code snippets showing both correct and incorrect approaches. Vague guidance without implementation examples is explicitly flagged.

Because this framework demands multiple markdown files with frontmatter and structured summaries, it adds noticeable boilerplate to simple or one-off agent instructions.

What it helps with

  • structure custom agent skills across SKILL.md and individual rule files
  • translate repository coding conventions into actionable agent rules
  • review skill definitions for concrete code examples and clear explanations
  • strip boilerplate and abstract advice from project instructions

Example prompts for the agent

  • Create a new agent skill for code review inside skills/ following skill-writing-best-practices
  • Review the markdown structure in skills/api-guidelines/ against skill-writing-best-practices

How to install skill-writing-best-practices

1Skills CLI (Vercel)

npx skills add sergiodxa/agent-skills --skill skill-writing-best-practices -a claude-code

2Manually: put the files in place

~/.claude/skills/skill-writing-best-practices/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/skill-writing-best-practices/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about skill-writing-best-practices

How to install skill-writing-best-practices in Claude Code?

Run the following command in your terminal: npx skills add sergiodxa/agent-skills --skill skill-writing-best-practices -a claude-code.

When does this skill activate?

The assistant references these guidelines whenever you create or modify files inside the skills/ directory.

What directory structure does this skill require?

It mandates a top-level SKILL.md file for summarized rules alongside a rules/ subfolder containing dedicated rule files.

Source text

SKILL.md · MIT
---
name: skill-writing-best-practices
description: Guidelines for creating AI agent skills. Use when writing new skills, documenting coding patterns, or reviewing skill files. Triggers when creating or modifying files in the skills/ directory.
---

# Skill Writing Best Practices

Patterns for creating effective AI agent skills that capture coding conventions and best practices. Contains 6 rules covering structure, content, and writing style.

## When to Apply

Reference these guidelines when:

- Creating a new skill from scratch
- Extracting patterns from an existing codebase
- Reviewing or improving existing skills
- Converting documentation into skill format

## Rules Summary

### Structure (HIGH)

#### skill-directory-structure - @rules/skill-directory-structure.md

Every skill has a SKILL.md and a rules/ directory.

```
skills/
└── topic-best-practices/
    ├── SKILL.md              # Main summary with all rules
    └── rules/
        ├── rule-name.md      # Detailed individual rules
        └── another-rule.md
```

#### skill-md-structure - @rules/skill-md-structure.md

SKILL.md has frontmatter, overview, and condensed rule summaries.

```markdown
---
name: topic-best-practices
description: When to use this skill.
---

# Topic Best Practices

Brief intro. Contains N rules across M categories.

## When to Apply

- Situation 1
- Situation 2

## Rules Summary

### Category (IMPACT)

#### rule-name - @rules/rule-name.md

One sentence. Code example.
```

#### rule-file-structure - @rules/rule-file-structure.md

Each rule file has frontmatter, explanation, examples, and takeaways.

```markdown
---
title: Rule Title
impact: HIGH
tags: [relevant, tags]
---

# Rule Title

What to do and why.

## Why

- Benefit 1
- Benefit 2

## Pattern

\`\`\`ruby
# Bad
bad_code

# Good
good_code
\`\`\`

## Rules

1. Takeaway 1
2. Takeaway 2
```

### Content (HIGH)

#### concrete-examples - @rules/concrete-examples.md

Every rule needs code examples. Abstract advice is hard to apply.

```markdown
# Bad: Too abstract
"Keep your code organized."

# Good: Concrete
"Place concerns in `app/models/model_name/` not `app/models/concerns/`."

\`\`\`ruby
# Shows exactly what to do
app/models/card/closeable.rb
\`\`\`
```

#### explain-why - @rules/explain-why.md

Don't just show what. Explain why it matters.

```markdown
## Why

- **Testability**: Sync method can be tested without job infrastructure
- **Flexibility**: Callers choose sync or async based on context
- **Clarity**: The `_later` suffix makes async behavior explicit
```

### Style (MEDIUM)

#### writing-style - @rules/writing-style.md

Write naturally. Avoid AI-isms and excessive formatting.

```markdown
# Bad
---
Here is an overview of the key points:
---

# Good
Group related rules by category. Each rule gets a one-sentence
description and a short code example.
```

## Philosophy

Good skills are:

1. **Concrete** - Every rule has code examples
2. **Reasoned** - Explains why, not just what
3. **Scannable** - Easy to find relevant rules quickly
4. **Honest** - Shows when NOT to use a pattern
5. **Natural** - Written like documentation, not AI output

© sergiodxa · MIT · sergiodxa/agent-skills

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set11

The whole set →
frontend-react-best-practices frontend-react-best-practices — a skill with 33 React performance rules: fewer wasted re-renders, leaner bundles, cleaner component composition. Useful while writing or refactoring components. CX Codex +1 1,200installs frontend-accessibility-best-practices frontend-accessibility-best-practices is a Claude Code skill with WCAG patterns for React components. It activates when building UI, forms or interactive elements, or reviewing code for accessibility. CX Codex +1 926installs frontend-tailwind-best-practices frontend-tailwind-best-practices is a Claude Code skill with 10 Tailwind CSS rules for component styling, covering stack utilities, gap spacing, dark color schemes, and className merging. CX Codex +1 470installs frontend-react-router-best-practices frontend-react-router-best-practices is a Claude Code skill that sets React Router architecture rules for parallel loaders and secure mutation handlers without client waterfalls. CX Codex +1 406installs frontend-js-best-practices frontend-js-best-practices provides 17 performance and style rules for JavaScript and TypeScript. Helps agents optimize loops, reduce algorithmic complexity, and avoid array mutations. CX Codex +1 341installs ruby-on-rails-best-practices ruby-on-rails-best-practices is a Claude Code skill that provides 16 Basecamp Rails conventions for models, thin controllers, background jobs, and Turbo broadcasts. CX Codex +1 283installs frontend-async-best-practices frontend-async-best-practices is a Claude Code skill for eliminating async waterfalls by parallelizing independent requests instead of awaiting them sequentially. CX Codex +1 228installs frontend-internationalization-best-practices frontend-internationalization-best-practices is a Claude Code skill with best practices for React Router and remix-i18next, covering middleware, locale detection, and SSR hydration sync. CX Codex +1 195installs

Project sponsors

Companies that keep this analytics open