How-to Guides

Diataxis quadrant: Task-oriented

Target Audience

Users and developers (with basic computer proficiency)

Purpose

Solve specific problems. Readers come with a clear task in mind, follow the guide to complete it, and leave. Titles should be verb-led task descriptions.

Writing Principles

• Use task-oriented title format: "How to xxx" or start with a verb
• Assume readers have completed environment setup; don't repeat basic steps
• Include error path handling (FAQ section)
• Extract code examples from actual runnable projects
• Link to architecture/ for "further reading"

Included Documents

• user-help.md --- User Help (installation, usage, template management)
• template-developer-guide.md --- Template Developer Guide
• release-process.md --- Release Process (versioning, changelog, release steps)
• contributing.md --- Contributing Guide (branching strategy, PR workflow, coding conventions)