veyepar: Motivating developers to write API documentation

Author(s):	Jennifer Hodgdon
Location	Room 1
Date	apr Mon 08	Days Raw Files
Start	12:11	First Raw Start	12:10
Duration	00:24:00	Offset	0:00:57
End	12:35	Last Raw End	12:57
Chapters	00:00 0:13:10
Total cuts_time	23 min.

http://lanyrd.com/2013/writethedocs/scfpdb/
raw-playlist raw-mp4-playlist encoded-files-playlist host archive public tweet mp4 svg png

assets release.pdf Motivating_developers_to_write_API_documentation.json
logs
Admin: episode episode list cut list raw files day marks day marks day image_files

State:

Locked:

clear this to unlock

Locked by:

user/process that locked.

Start:

initially scheduled time from master, adjusted to match reality

Duration:

length in hh:mm:ss

Name:

Video Title (shows in video search results)

Emails:

email(s) of the presenter(s)

Released:

has someone authorised pubication

Normalise:

Channelcopy:

m=mono, 01=copy left to right, 10=right to left, 00=ignore.

Thumbnail:

filename.png

Description:

markdown

Everyone attending this conference probably agrees that it’s a benefit in any software project to have good API documentation. But how do you get it written? There are three possible strategies: (a) Developers write the API documentation, (b) Technical writers write the API documentation, and (c) No one writes the API documentation. Option (c) is obviously undesirable, and option (b) is only viable in a corporate setting, so in open-source, the question becomes: how to motivate developers to write good API documentation.
In the Drupal open-source project, API documentation has become one of the “Core Gates” that (in theory anyway) all patches must pass through to get committed to Drupal Core, which has taken API documentation from being an afterthought to being a requirement. This talk will go over:

The &quot;Core Gates&quot; concept and how it came about
  The requirements for the Documentation &quot;gate&quot;
  The Drupal project’s documentation standards
  How it’s working in practice

Comment:

production notes

2013-04-08/12_10_03.dv Apply: 12:10:03 - 12:11:28 ( 00:01:25 ) S: 12:10:03 - E: 12:11:28 D: 00:01:25 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_10_03.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:10:03		seconds: 0.0 Wall: 12:10:03
Duration	00:01:25
	12:11:28		seconds: 0.0 Wall: 12:10:03
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_11_29.dv Apply: 12:11:29 - 12:24:39 ( 00:13:10 ) S: 12:11:29 - E: 12:24:39 D: 00:13:10 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_11_29.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:11:29		seconds: 0.0 Wall: 12:11:29
Duration	00:13:10
	12:24:39		seconds: 0.0 Wall: 12:11:29
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_24_39.dv Apply: 12:24:39 - 12:35:16 ( 00:10:37 ) S: 12:24:39 - E: 12:35:16 D: 00:10:37 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_24_39.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:24:39		seconds: 0.0 Wall: 12:24:39
Duration	00:10:37
	12:35:16		seconds: 0.0 Wall: 12:24:39
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_35_17.dv Apply: 12:35:17 - 12:36:25 ( 00:01:08 ) S: 12:35:17 - E: 12:36:25 D: 00:01:08 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_35_17.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:35:17		seconds: 0.0 Wall: 12:35:17
Duration	00:01:08
	12:36:25		seconds: 0.0 Wall: 12:35:17
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_36_25.dv Apply: 12:36:25 - 12:36:29 ( 00:00:04 ) S: 12:36:25 - E: 12:36:29 D: 00:00:04 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_36_25.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:36:25		seconds: 0.0 Wall: 12:36:25
Duration	00:00:04
	12:36:29		seconds: 0.0 Wall: 12:36:25
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_36_30.dv Apply: 12:36:30 - 12:40:58 ( 00:04:28 ) S: 12:36:30 - E: 12:40:58 D: 00:04:28 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_36_30.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:36:30		seconds: 0.0 Wall: 12:36:30
Duration	00:04:28
	12:40:58		seconds: 0.0 Wall: 12:36:30
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_40_58.dv Apply: 12:40:58 - 12:41:11 ( 00:00:13 ) S: 12:40:58 - E: 12:41:11 D: 00:00:13 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_40_58.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:40:58		seconds: 0.0 Wall: 12:40:58
Duration	00:00:13
	12:41:11		seconds: 0.0 Wall: 12:40:58
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_41_12.dv Apply: 12:41:12 - 12:46:18 ( 00:05:06 ) S: 12:41:12 - E: 12:46:18 D: 00:05:06 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_41_12.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:41:12		seconds: 0.0 Wall: 12:41:12
Duration	00:05:06
	12:46:18		seconds: 0.0 Wall: 12:41:12
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_46_18.dv Apply: 12:46:18 - 12:46:32 ( 00:00:14 ) S: 12:46:18 - E: 12:46:32 D: 00:00:14 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_46_18.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:46:18		seconds: 0.0 Wall: 12:46:18
Duration	00:00:14
	12:46:32		seconds: 0.0 Wall: 12:46:18
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_46_33.dv Apply: 12:46:33 - 12:51:42 ( 00:05:09 ) S: 12:46:33 - E: 12:51:42 D: 00:05:09 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_46_33.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:46:33		seconds: 0.0 Wall: 12:46:33
Duration	00:05:09
	12:51:42		seconds: 0.0 Wall: 12:46:33
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_51_43.dv Apply: 12:51:43 - 12:51:55 ( 00:00:12 ) S: 12:51:43 - E: 12:51:55 D: 00:00:12 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_51_43.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:51:43		seconds: 0.0 Wall: 12:51:43
Duration	00:00:12
	12:51:55		seconds: 0.0 Wall: 12:51:43
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_51_55.dv Apply: 12:51:55 - 12:56:29 ( 00:04:34 ) S: 12:51:55 - E: 12:56:29 D: 00:04:34 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_51_55.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:51:55		seconds: 0.0 Wall: 12:51:55
Duration	00:04:34
	12:56:29		seconds: 0.0 Wall: 12:51:55
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_56_29.dv Apply: 12:56:29 - 12:57:24 ( 00:00:55 ) S: 12:56:29 - E: 12:57:24 D: 00:00:55 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_56_29.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:56:29		seconds: 0.0 Wall: 12:56:29
Duration	00:00:55
	12:57:24		seconds: 0.0 Wall: 12:56:29
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

2013-04-08/12_57_47.dv Apply: 12:57:47 - 12:57:51 ( 00:00:04 ) S: 12:57:47 - E: 12:57:51 D: 00:00:04 show more...

vlc ~/Videos/veyepar/eric/write_the_docs_2013/dv/room_1/2013-04-08/12_57_47.dv :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	12:57:47		seconds: 0.0 Wall: 12:57:47
Duration	00:00:04
	12:57:51		seconds: 0.0 Wall: 12:57:47
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete