docs-writer

What problem does it solve?

This Skill eliminates the burden of writing various technical documents from scratch, ensuring clarity, consistency, and adherence to best practices. It saves time on creating READMEs, API documentation, user guides, architecture documents, and code comments.

Core Features & Use Cases

• Versatile Documentation: Create API documentation, user guides, developer documentation, architecture documents, and code comments.
• Markdown Best Practices: Ensures proper formatting, clear hierarchy, and working code examples for high-quality output.
• Output Quality: Provides complete, tested documentation files with clear section hierarchy and a table of contents for longer documents.
• Use Case: You've just finished a new feature and need to update the README and API documentation. This Skill can generate both, ensuring they are clear, concise, and follow your project's standards, complete with code examples.

Quick Start

Use the docs-writer skill to create a comprehensive README.md file for the attached Python project, including installation and usage instructions.