veyepar: Self-Documenting Coders: Writing Workshop for Devs

Author(s):	Heidi Waterhouse
Location	Large POD Room CB11.04.400
Date	jan Fri 26	Days Raw Files
Start	10:45	First Raw Start	10:27
Duration	0:100:0	Offset	0:17:14
End	12:25	Last Raw End	12:27
Chapters	00:00 0:13:01 0:26:14 0:32:48 0:53:53 0:56:32 1:04:29
Total cuts_time	80 min.

http://lca2018.linux.org.au/schedule/presentation/99/
raw-playlist raw-mp4-playlist encoded-files-playlist host archive public tweet mp4 svg png

assets release.pdf SelfDocumenting_Coders_Writing_Workshop_for_Devs.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

Being able to use language effectively saves so much coding trauma. You should learn to file good bug reports, write up problems, and describe what you're doing. I'll teach you in less than half a day!

What is a documentation structure, and why does it matter to developers? 
Lots of developers get asked to write their own documentation, especially internal documentation and onboarding. In theory, this is good because they know the problems they are writing about and don't need to spend time explaining them. In practice, developers avoid this work because they don't have a good idea of how to start and can't evaluate whether they have succeeded.

This workshop is designed to teach you a few basic theories of technical documentation, such as task-based topics, reusable content, and writing for an audience. After the overview, you'll learn techniques for writing bug reports, error messages, and onboarding instructions in a tool-agnostic, repeatable way. You'll leave this workshop with a handful of techniques, templates, and tests that will improve your team’s communication and your life as a developer.

Comment:

production notes

2018-01-26/11_27_46.ts Apply: 11:48:51 - 11:55:06 ( 00:06:15 ) S: 11:27:46 - E: 11:57:45 D: 00:29:59 (Start: 1265.0) (End: 1640.0) show more...

vlc ~/Videos/veyepar/lca/lca2018/dv/largepod/2018-01-26/11_27_46.ts :start-time=01265.0 --audio-desync=0

	Raw File	Cut List
	11:27:46		seconds: 1265.0 Wall: 11:48:51
Duration	00:29:59
	11:57:45		seconds: 1640.0 Wall: 11:55:06
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete