authoring-user-docs
Installation
SKILL.md
Authoring User Docs Action
Produces tutorials, how-to guides, user guides and onboarding guides — the learning-oriented and task-oriented quadrants of the Diátaxis framework.
Load authoring-technical-docs first for the multi-pass workflow, style rules, and quality framework. This action provides the templates and user-doc-specific rules. Then, follow the creation of referenced documents in ´Templates´ section.
Choosing the right type
| Tutorial | How-To Guide | User Guide | Onboarding Guide | |
|---|---|---|---|---|
| Audience | Beginners | Users who know the basics | All experience levels | New team members or developers joining a project |
| Structure | Linear journey | Task-focused | Chapter-style, comprehensive | Sequential, milestone-based |
| Goal | "I learned how this works" | "I accomplished my task" | "I understand the whole product" | "I'm ready to contribute to the project" |
Best Practices for Writing Tutorials
1. Know and Address Your Audience Write in approachable, conversational "you" language rather than formal passive voice. Meet the reader where they are, and don't bury context they need to feel oriented.