write-readme

To generate a README from rough context, provide your scattered project notes and specify the repository boundary. The skill analyzes the available context, applies markdown templates, and outputs a ready-to-publish document with YAML frontmatter.

You can create README documents for root projects, individual modules, APIs, and documentation indexes. The skill adapts to the specified boundary and available local context to produce appropriately scoped markdown files.

Yes, the generated README markdown includes a YAML frontmatter block containing the project name and description. This ensures the documentation maintains standard repository metadata alongside the published content.

To preserve existing terminology when refining documentation, the skill loads relevant templates from its references directory and retains your original project vocabulary while restructuring the rough context into coherent markdown.

The best way to structure a docs index is to define the documentation boundary and provide local context. The skill evaluates the repository structure and generates a markdown index that communicates boundary, purpose, and usage clearly.

Yes, you can automate repository documentation creation using existing markdown templates. The skill leverages templates from its references directory to transform rough project ideas into structured, ready-to-publish README files.