readme-writer

To structure a module README, use a standard layout with Overview, Usage, API, and Examples sections. Include YAML frontmatter with name and description, keep language concise, and provide at least one concrete example to reduce onboarding time.

A developer-focused README should include placement guidelines, purpose, input/output details, and real-world examples. It must use concise language to help others understand usage and interdependencies without digging into the underlying code.

You should place your README.md file directly next to the module, package, or subsystem it documents. This placement ensures the documentation is immediately accessible to developers navigating the codebase.

Yes, a module README requires YAML frontmatter containing a name and description. This metadata establishes a consistent structure across different module sizes, from small utilities to large libraries, ensuring clear identification.

Yes, the same standard README structure applies across different module sizes. The generated templates cover placement, structure, and examples suitable for both small utilities and large libraries while maintaining consistent developer-focused documentation.