write-convention

Creates, edits, or deletes convention files under docs/conventions/ and syncs the AGENTS.md convention list.

Updated Mar 21, 2026
One-click install
npx skills add https://github.com/mikestopcontinues/agent-skills --skill write-convention-mikestopcontinues
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-convention
Source: https://github.com/mikestopcontinues/agent-skills/tree/main/claude/skills/write-convention
Command: npx skills add https://github.com/mikestopcontinues/agent-skills --skill write-convention-mikestopcontinues

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project conventions consistent is hard when files under docs/conventions/ drift out of sync with the index in docs/AGENTS.md. This Skill enforces one-convention-per-file authoring with strict path discipline and automatically regenerates the AGENTS.md convention list on every change. ## Core Features & Use Cases - Scoped convention authoring: Create, overwrite, edit, or delete a single convention file under docs/conventions/ using only a kebab-case name, never a caller-supplied path. - Path traversal refusal: Rejects names containing slashes, dot segments, or absolute paths, and reports the boundary violation instead of silently normalizing it. - AGENTS.md list regeneration: Rebuilds the bullet list between the conventions:start/end HTML markers from the on-disk listing, preserving all content outside the markers byte-for-byte. - Use Case: A team lead asks the agent to add a new naming convention; the Skill writes docs/conventions/branch-naming.md and updates the AGENTS.md index in one pass. ## Quick Start Ask the agent to create a convention named branch-naming with your markdown content using the write-convention skill.

Frequently Asked Questions about write-convention

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new project convention file?▼

Provide a kebab-case name and the full markdown content; the Skill writes it to docs/conventions/<name>.md and regenerates the convention list in docs/AGENTS.md. You never supply a file path yourself.

How do I delete a convention and update AGENTS.md?▼

Pass the convention name with the delete flag set. The file is removed and the AGENTS.md marker region is regenerated from the remaining on-disk files, so stale entries disappear automatically.

What is the difference between write-convention and write-doc?▼

write-convention is narrower: it only touches files under docs/conventions/ plus the AGENTS.md marker region, with stricter path discipline. General documentation edits outside that scope belong to write-doc.

Why was my convention path refused?▼

The Skill refuses any name containing slashes, backslashes, or dot segments, and any resolved target outside docs/conventions/. Pass a bare kebab-case name instead of a full path like docs/conventions/../other.md.

What happens if AGENTS.md is missing the conventions markers?▼

If AGENTS.md does not exist, the Skill creates a minimal stub with the markers. If the file exists but lacks the conventions:start marker, it refuses with a clear error rather than guessing where to insert the list.