authoring-user-docs

What problem does it solve?

This Skill assists in creating user-facing documentation such as tutorials, how-to guides, user guides, and onboarding materials, ensuring clarity and effectiveness for the target audience.

Core Features & Use Cases

• Guidance on Documentation Types: Helps choose between tutorials, how-to guides, user guides, and onboarding guides based on audience and goal.
• Best Practice Adherence: Provides detailed best practices for writing each type of user documentation, covering audience engagement, structure, formatting, and validation.
• Template Provision: Offers templates for various user documentation types to streamline the creation process.
• Use Case: A software team needs to create a new user guide for their latest feature. This Skill provides the structure, best practices, and templates to ensure the guide is comprehensive, easy to follow, and meets user needs.

Quick Start

Use the authoring-user-docs skill to generate a tutorial for a new software feature.