Accelint Readme Writer

What it does

This skill generates structured README files for software projects, translating raw code or project details into professional documentation. It formats output with standard Markdown conventions to ensure clarity and consistency across repositories.

When to use it

• You need to document a new open-source library or tool quickly without writing docs from scratch.
• Your team requires standardized formatting for multiple microservices or submodules within a monorepo.
• You want to convert technical specifications or code comments into a polished README.md for public consumption.

Key capabilities

• Generates full Markdown README files with appropriate headers and sections.
• Structures content logically, including installation instructions, usage examples, and feature lists.
• Adapts tone and detail level based on the input project context.

Example prompts

• "Create a README for my Python data processing library that includes setup steps and a code example."
• "Write a documentation file for a new React component suite highlighting its key features and API usage."
• "Generate a README for a Rust CLI tool, including installation commands and configuration options."

Tips & gotchas

Ensure you provide sufficient context about the project's purpose and specific technical requirements to avoid generic output. The skill relies on accurate input details; vague descriptions may result in incomplete or inaccurate documentation sections.