oakmac/cuttle

Provide context for new users

Open

#30 opened on Jan 7, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (316 stars) (11 forks)batch import
enhancementhelp wanted

Description

The experience for a first-time user should be stellar (see Issue #1).

The tool should:

  • Explain what it's doing / installing.
  • Have clear call-to-actions to create your first project.
  • Provide context when faced with initial decisions.

Contributor guide

Tech stack
javascript
Domain
developer experiencedocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Familiarity with the cuttle toolBasic web development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the current user interface of the cuttle tool. Identify where first time users might lack context. Propose a design for adding explanatory text, call to action buttons, and contextual help. Consider including a welcome screen or interactive guide. Reference the issue body's requirements and discuss with maintainers for clarification on scope.