doc-writer

To generate a README file, provide the AI with your project details and setup instructions. It drafts a structured markdown document with features and setup guides, saving manual writing hours and improving project onboarding.

Maintaining changelogs is done by standardizing release notes and update logs using popular formats. The Skill helps structure these markdown files, ensuring technical content stays accessible, organized, and current with recent code changes.

Yes, you can write API references by incorporating developer-supplied information and existing comments into coherent documents. It helps produce detailed API documentation and insightful comments for complex algorithms.

To update technical documentation, the Skill reads and edits markdown files to reflect recent code changes. It facilitates creating up-to-date documentation, preventing project onboarding confusion and maintenance inefficiency.

Yes, markdown files are required as it reads and edits markdown to produce structured documents. The Skill uses markdown to maintain changelogs, README files, and API references for software projects.