-
Notifications
You must be signed in to change notification settings - Fork 3
/
NOTES.rst
55 lines (28 loc) · 1.28 KB
/
NOTES.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
* pick a style guide
e.g. https://developers.google.com/style
Local: WordNet is a proper name, 'wordnet' is a common noun
* technical writers work 20-30 hours a week
* try to be fun, so the writers will want to stay on
* scope small --- try to get something doable
* metrics to measure docs
* aim for multi-lingual messages
* try to be welcoming
* try to be clear about what the documentation is meant to acheive
* allow wordnet users to understand the relationships
* allow wordnet developers to understand the relationships
* need to have a fixed goal
Allow for feedback, make a FAQ?
MAKE SURE WE MAKE EACH PROJECT SMALL
Good to emphasize that we will try to answer questions. Give direct
email for this.
Eri McKean from WordNik is one of the organizers!
Set up a branch for the documentation (Mike or John help)
Have our local guide to show what we are doing
Set up a regular time to talk
Contributors guide (we should have one)
long-running or short-running
====================================
https://developers.google.com/season-of-docs/docs/2019/participants
https://www.digitalocean.com/currents/october-2018/
https://opensourcesurvey.org/2017/
https://cdn2.hubspot.net/hubfs/4008838/Resources/The-2019-Tidelift-managed-open-source-survey-results.pdf