OpenParable
Skip to content
← Back to skills

Markdown Writer

Documents
markdown-writer

Markdown Writer is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Edit and create markdown files with consistent style. Use when: (1) Creating or updating README files, (2) Editing documentation, (3) Writing DONE.md, PLAN.md, RESEARCH.md, (4) Any .md file edits. Follows Paul Graham writing style: short sentences, direct claims, no hedging.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/markdown-writer/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/markdown-writer, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Markdown Writer

Edit markdown files with consistent tone and style.

When to Use

  • README.md updates
  • Documentation in /docs folders
  • Project status files (DONE.md, PLAN.md, RESEARCH.md)
  • Any .md file that needs clear, direct writing

Writing Style

Voice

  • Write like speaking to an intelligent friend
  • Short sentences. Direct claims. No hedging.
  • First person for opinions and experience
  • Active voice, not passive
  • State claims confidently. No waffling.

Punctuation Rules

  • Never use em dashes (—)
  • Use periods and new sentences for separate thoughts
  • Use commas for simple asides
  • Use parentheses for clarifying information
  • Use colons for lists or elaboration

Structure

  • Start with the point, not background
  • One idea per paragraph
  • Headers should be claims, not topics
  • End sections when the point is made

Technical Writing

  • Code examples should be minimal and functional
  • Explain the why, not just the what
  • Link to deeper resources rather than over-explaining

Quality Checklist

Before finalizing:

  • No em dashes in content
  • Sentences are short and direct
  • Opens with the main point
  • Code examples are minimal
  • Tables used for structured data
  • Lists used for sequences or options