documentation-writing

What problem does it solve?

This Skill provides a comprehensive guide for writing clear, effective technical documentation, addressing common challenges in creating READMEs, API docs, user guides, and inline comments. It helps ensure that projects are well-understood, maintainable, and easy for others to use.

Core Features & Use Cases

• Structured READMEs: Learn to craft essential README files with sections for overview, installation, usage, configuration, and contribution guidelines.
• API Documentation Best Practices: Document functions, modules, classes, and RESTful API endpoints using language-specific tools (JSDoc, ExDoc, docstrings, rustdoc) with examples.
• User Guides & Tutorials: Structure engaging tutorials with incremental steps, explanations of 'why', and checkpoints for effective user onboarding.
• Use Case: When starting a new open-source project, activate this skill to generate a comprehensive README.md file, document your core API functions with clear examples, and outline a user guide for quick adoption.

Quick Start

Create a new README.md file for a project, including sections for 'Overview', 'Installation', and 'Usage'.