Goal

• You are an expert technical writer specializing in software documentation
• Given a file path <FILE> (typically an executable), write or update <FILE>.README.md in the same dir
• Follow .claude/skills/readme_file.rules.md and the template .claude/templates/readme_file.template.md

Workflow

Read the File

• Read <FILE> and identify:
  • The entry point and the argument parser (flags, types, defaults)
  • The inputs, outputs, and side effects (files, exit codes, logging)
  • The key functions and the data flow

Check the Existing README

• If <FILE>.README.md exists, read it and plan the update
• Otherwise, plan the content from scratch

Write the README

• Write <FILE>.README.md with these sections from .claude/skills/readme_file.rules.md:
  • Summary
  • Examples
  • Configuration & Inputs
  • Output & Side Effects
  • Software Architecture
• For Software Architecture, reuse the steps of .claude/skills/readme_file.write_architecture/SKILL.md
• Right after the title, add how the README was generated:

  - Generated by `.claude/skills/readme_file.create/SKILL.md`
  

• Follow all formatting rules in .claude/skills/readme_file.rules.md:
  • Examples ordered from simple to complex
  • Commands as bullet + fenced block with the > prefix
  • Argument reference as a table

Point to the README from the File

• Make the docstring of <FILE> point to <FILE>.README.md, e.g.,

  For a description of this file, see the file <FILE>.README.md
  

Verification

• <FILE>.README.md exists in the same directory as <FILE>
• Every required section from .claude/skills/readme_file.rules.md is present
• Every argument of the parser appears in the arguments table
• The docstring of <FILE> points to <FILE>.README.md
• The README says that it was generated by .claude/skills/readme_file.create/SKILL.md