1- Collaboration in the world of Tutorials
2- =======================================
1+ The Collaboration Machine of the Docs World
2+ ===========================================
33
4- You love open source software, right?
4+ We all love and depend on open source software.
55
6- What about open source content?
6+ But what about open source content?
77
8- We're now in a software Rennaisance. Open Source Software and tools like
9- GitHub let us work together brilliantly. The result is huge gains in quality
10- and innovation. That's really important.
8+ Open Source Software and tools like GitHub let us work together brilliantly.
9+ The result is huge gains in quality and innovation. That's really important.
1110
1211But content - the documentation, tutorials and books that teach us about all
1312of this tech - is behind the curve. Yes, official documentation is usually
14- on a GitHub repository and we see a huge community effort with the
15- `Symfony documentation `_. Even StackOverlow is an example of crowd-sourcing
16- the information-side of tech. But mostly, books, blog posts and everything in
17- between are still written by one person. They sit, slowly rot with time,
18- and are eventually forgotten. New books are written by new authors from scratch.
19- The cycle continues.
13+ on a GitHub repository and we see a **huge ** community effort with the
14+ `Symfony documentation `_ (nod to `@WouterJ `_ - pronounced Wow!ter). Even
15+ StackOverlow is an example of crowd-sourcing the information-side of tech.
16+ But mostly, books, blog posts and everything in between are still written
17+ by one person. They sit, slowly rot with time, and are eventually forgotten.
18+ New books are written by new authors from scratch. The cycle continues. We're
19+ all part of it.
2020
2121This cycle is an antique. And like most things that move slowly, the Internet
22- will fix this. Imagine a world where tutorials are based on real, high-quality
23- projects written by many people. That's where I want to go.
22+ will correct this. Imagine a world where tutorials are based on real, high-quality
23+ projects written by many people and evolving over time. That's where I want
24+ to be.
2425
25- Colaboration Now
26- ----------------
26+ Making Content Editable
27+ -----------------------
2728
28- So, how can we push this forward? We're starting by (being really lucky to)
29- collaborate with some brilliant people:
29+ More and more blogs are using GitHub-backed repositories, and although there
30+ isn't a culture (yet) of contributing like we do to code, I think it's inevitable.
31+
32+ Our screencast and blog content is also open source and lives up on `GitHub `_.
33+ That's actually not new, but the **"Edit" ** button at the top of this page
34+ and the contributers on the right *is * new. Get your avatar up there and
35+ push the culture of docs contributing by PR'ing some content. I even left
36+ a typo in this paragraph (though there's probably more on the page). Find it!
37+
38+ Reading from the Shoulders of Giants
39+ ------------------------------------
40+
41+ Often there are topics I need to learn and a person that I know could build
42+ a *perfect * tutorial to teach me. For that reason, I've started humbly asking
43+ really smart (and busy) people to help write future tutorials: they bring
44+ expertise, we hopefully help with a lot of the not-so-fun work (writing,
45+ editing, video recording, etc).
46+
47+ We're starting by (being really lucky to) collaborate with some brilliant
48+ people:
3049
3150* `Brent Shaffer `_ is our partner for the `OAuth 2.0 in 8 Steps `_ tutorial.
3251 In addition to being our mega-expert, he drew us `ridiculous farming pictures `_.
@@ -35,36 +54,34 @@ collaborate with some brilliant people:
3554 This is amazing, because it means having a real-world tutorial written
3655 by one of the leaders in building technology that helps make RESTy sites.
3756
38- .. info ::
39-
40- And if you're great at something, we want to bring your knowledge to
41- life too. Comment here or bother us on `Twitter `_.
42-
43- What else?
44-
45- Our screencast and blog content is also open source and lives up on `GitHub `_.
46- That's actually not new, but the "Edit" button at the top of this page and
47- the contributors on the right *is * new. Do us all a favor and get your face
48- up on the site. I even left a typo in this paragraph (though there's probably
49- on the page). Find it!
57+ And if you're great at something and I haven't already bothered you - ping
58+ us on `Twitter `_ or comment here. I want to bother you :).
5059
5160Why Don't we all Write More?
5261----------------------------
5362
54- If the problem is ultimately that we all need write more, then why don't
55- we? What stops us from all writing tutorials? Here are some reasons I think:
63+ If the problem is ultimately that we should all write more (and collaborate),
64+ then why don't we? What stops us from writing the tutorials we wish existed?
65+ I'd genuinely like to hear from you (again, comments!).
5666
57- - There's nowhere easy to publish it (same as blog posts) - not true for everyone;
67+ Here are some reasons *I * think, which could be totally wrong:
68+
69+ - There's nowhere easy to publish it (this is not true for everyone);
5870
5971- It's way more fun to just write code;
6072
61- - A tutorial and code are disconnected - I need to write an app and *then *
62- go back and write it all. I'll have to copy code into the tutorial, which
63- may be wrong or get outdated.
73+ - There's nobody coordinating collaboration;
74+
75+ - A tutorial and its code are disconnected - I need to write an app and *then *
76+ go back and document the steps. I'll have to copy code into the tutorial,
77+ which may be wrong or get outdated.
6478
65- Are these right ? Wrong? What stops you from writing a tutorial?
79+ Right ? Wrong? What stops you from writing a tutorial?
6680
6781Code collaboration blew up when GitHub made the process easy and rewarding.
68- I hope we can help do the same for tutorials. Stay tuned.
82+ I hope we can help do the same for tutorials... and include everone on the
83+ process.
6984
7085<3 Ryan
86+
87+ .. _`@WouterJ` : https://twitter.com/wouterjnl
0 commit comments