authoring-user-docs

Generate tutorials, how-to guides, and user guides with templates.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/wizeline/sdlc-agents --skill authoring-user-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: authoring-user-docs
Source: https://github.com/wizeline/sdlc-agents/tree/main/aicores/documentation-writer-agent/skills/authoring-user-docs
Command: npx skills add https://github.com/wizeline/sdlc-agents --skill authoring-user-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

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.

Frequently Asked Questions about authoring-user-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What's the best way to write a user guide for a new software feature?

User documentation types differ by goal: tutorials are learning-oriented for new users, how-to guides are task-oriented for specific goals, and user guides provide comprehensive reference for operating software products effectively.

How do I create onboarding materials that engage new users effectively?

To create onboarding materials, select the appropriate documentation type based on your audience and goal, then use provided templates to structure the content, ensuring it follows best practices for engagement and clarity.

When should I use a tutorial versus a how-to guide for technical writing?

Use a tutorial when the goal is learning-oriented for new users, and choose a how-to guide when the need is task-oriented to help users achieve a specific objective within your software product.

Does this approach provide templates for software product documentation?

Yes, this approach provides templates for various user documentation types including tutorials, how-to guides, user guides, and onboarding materials to streamline the content creation process.

How do I choose the right documentation type for my audience and goals?

Choose the right documentation type by evaluating whether your goal is learning-oriented, requiring tutorials and onboarding materials, or task-oriented, requiring how-to guides and comprehensive user guides.