sod_idea.md 2.02 KB
Newer Older
1
Create Web Tutorials - Purr Data
Jonathan Wilkes's avatar
Jonathan Wilkes committed
2
3
4
5
6
7
8
9
10
11

About Our Org
-------------

Purr Data

About Your Project
------------------

### Problem
12
13
14
Purr Data is aimed at musicians, artists, and other people who aren't
necessarily programmers. This audience often has difficulty installing the
software and configuring it.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
15

16
17
18
19
It would help our new users immensely to have an online tutorial that leverages
our recent version of Purr Data that runs as a web app. This way users do not
need to install or even configure the software in order to run the tutorial,
output sound, and experiment with building their applications.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
20
21

### Scope
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
We will need a technical writer and a graphic designer to put together a
compelling, approachable set of short tutorials that introduce our audience
to the core topics. There are at least three pieces of prior art that may
be used as a starting point. However, these tutorials leave many of the basic
concepts unstated (e.g., they assume the user has prior programming knowledge,
or skip over important details), aren't always written clearly, and often
feature examples that are too complicated.

The final product should be comprised of accessible prose that explains a
topic, along with a small, simple example the user can interact with leveraging
the web app.

There are a number of veteran users who can help put together simple, clear
examples for each tutorial. The technical writer will write prose that explains
the concept to a general audience of non-programmers.

Finally, the graphic designer will work with the technical writer to produce
any graphs or charts the writer needs to elucidate a concept. Additionally,
since Purr Data is a diagram-based language, the designer can provide feedback
on color and design choices in the simple examples to help keep things clear
and clean looking.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
43
44

### Measuring Success
45
46
There is a rather active Facebook Group who we can get to test out the new
tutorial and provide feedback.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
47
48
49
50
51
52
53
54
55
56
57

Budget
------

inline or link

Additional Info
---------------

* Previous experience with technical writers or documentation