Markdown file types

Common .md files for AI and software projects

Modern projects use Markdown files for humans, AI coding agents, documentation systems, changelogs, prompts, and design decisions.

The most useful .md files

FilePurpose
README.mdProject overview, setup, usage, and first context layer.
AGENTS.mdInstructions for AI coding agents.
CLAUDE.mdClaude Code project memory and workflow rules.
DESIGN.mdDesign intent, architecture decisions, and trade-offs.
SKILL.mdDefines an Agent Skill with YAML frontmatter and instructions.
CONVENTIONS.mdTool-neutral coding standards for AI coding agents.
CHANGELOG.mdRelease notes and version history.
TODO.mdTask list, backlog, or implementation checklist.
PROMPTS.mdReusable AI prompts and prompt patterns.
API.mdAPI endpoints, examples, payloads, and auth notes.
CONTRIBUTING.mdContribution rules, branch workflow, and review expectations.
SECURITY.mdSecurity policy and how to report a vulnerability.

How these files work together

Each file owns a different layer of context. Use README.md as the front door for humans. Use AGENTS.md and CLAUDE.md to guide AI coding agents. Use DESIGN.md to explain intent before code changes. Use CHANGELOG.md and TODO.md to keep project state visible. Use PROMPTS.md when your team repeatedly asks AI tools to perform similar work.

Think of them as a stack: README for "what", DESIGN for "why", AGENTS and CLAUDE for "how the agent should work", and CHANGELOG for "what changed". Together they give both people and models a complete, plain-text map of the project.

README, AGENTS, CLAUDE, and DESIGN at a glance

FileAudienceAnswers
README.mdHumansWhat is this and how do I use it?
AGENTS.mdAny coding agentHow do I build, test, and behave here?
CLAUDE.mdClaude CodeWhat context and rules apply to this project?
DESIGN.mdTeam and agentsWhy was it built this way?

Each tool also has its own instruction file, from GEMINI.md and Cursor rules to Copilot instructions. The AI agent instruction files guide compares all of them.

Why file names matter for AI

Predictable names help humans and agents find the right context quickly. A coding agent can infer that README.md is a project overview, AGENTS.md is an instruction file, and DESIGN.md contains decisions. Clear names reduce ambiguity and improve retrieval. The same idea now extends to whole sites through llms.txt, a root-level Markdown file that tells AI models what a site is about.

Recommended folder pattern

project/
  README.md
  AGENTS.md
  CLAUDE.md
  DESIGN.md
  CHANGELOG.md
  TODO.md
  docs/
    API.md
    PROMPTS.md
    ARCHITECTURE.md

Edit and preview your .md files

Use Markdown Docs online editor for quick previews or download Markdown Docs to open and edit local `.md` files on Windows.

Related references

FAQ

Do all projects need every .md file?

No. Start with README.md. Add AGENTS.md, CLAUDE.md, DESIGN.md, or PROMPTS.md only when the project needs that type of context.

Are Markdown file names case-sensitive?

On some systems, file names can be case-sensitive. Use conventional uppercase names like README.md, AGENTS.md, and CLAUDE.md for clarity.

Can Markdown Docs edit all these files?

Yes. Markdown Docs can open, edit, preview, and save Markdown files such as README.md, AGENTS.md, CLAUDE.md, DESIGN.md, TODO.md, and CHANGELOG.md.