Write The Docs EU 2015: move talk abstracts into description field

writethedocs-eu-2015/videos/adam-dangoor-tested-correct-how-to-make-sure-your-documentation-keeps-working.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "When you are writing documentation for software, a top priority is\nsurely that what you write is correct. That is, the examples you provide\ngive the output you say they will. Or perhaps it is that the links in\nyour documentation link to an expected page. Usually this is done with\nmanual testing at the time of writing. Your organisation may have\npractices in place to make sure that these examples don't get too out of\ndate - maybe someone checks them periodically, maybe code review comes\nwith comments like \"I remember that this part of the code is used in an\nexample on Page 37 of our docs, change it\". But these methods are\ntedious and flawed. This talk will give examples from my work as a\nsoftware engineer in creating tested snippets for documentation which\nare linked to the code they represent. It will show how using techniques\ntraditionally reserved for software testing can ease the burden of\nkeeping documentation up to date.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "When you are writing documentation for software, a top priority is\nsurely that what you write is correct. That is, the examples you provide\ngive the output you say they will. Or perhaps it is that the links in\nyour documentation link to an expected page. Usually this is done with\nmanual testing at the time of writing. Your organisation may have\npractices in place to make sure that these examples don't get too out of\ndate - maybe someone checks them periodically, maybe code review comes\nwith comments like \"I remember that this part of the code is used in an\nexample on Page 37 of our docs, change it\". But these methods are\ntedious and flawed. This talk will give examples from my work as a\nsoftware engineer in creating tested snippets for documentation which\nare linked to the code they represent. It will show how using techniques\ntraditionally reserved for software testing can ease the burden of\nkeeping documentation up to date.\n",
   "duration": 1427,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/anna-jaruga-the-quest-for-scientific-credit-for-software-documentation.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "Modern geoscientific research relies heavily on numerical computations\ninvolving complex software developed by physicists or chemists. It would\nseem that scientists should be well versed in ways of documenting and\nexplaining their research. Yet, when it comes to the documentation of\nscientific software projects, one soon realises that scientific wisdom\nis spread mostly by LaTeX and that the word 'documentation' starts to\nmean something completely different.\n\nWriting a documentation for a scientific project can be quite\nchallenging. There are not that many examples of well-documented\nopen-source geoscientific numerical modelling software projects to drew\nthe inspiration from. Even though the scientific results should be\nreproducible, mechanisms that reward those who deliver well documented\nsoftware are still to become widespread. The scientists are judged\nbasing on the number of peer-reviewed papers they publish, therefore\ninvesting the time solely to offer the documentation is difficult. The\ndocumentation should include the actual mathematical equations and\ntheory behind the software, figures documenting the scientific results\nas well as code listings and usage examples. The target audience may\nhave a strong background in science, computer science, both or neither.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "Modern geoscientific research relies heavily on numerical computations\ninvolving complex software developed by physicists or chemists. It would\nseem that scientists should be well versed in ways of documenting and\nexplaining their research. Yet, when it comes to the documentation of\nscientific software projects, one soon realises that scientific wisdom\nis spread mostly by LaTeX and that the word 'documentation' starts to\nmean something completely different.\n\nWriting a documentation for a scientific project can be quite\nchallenging. There are not that many examples of well-documented\nopen-source geoscientific numerical modelling software projects to drew\nthe inspiration from. Even though the scientific results should be\nreproducible, mechanisms that reward those who deliver well documented\nsoftware are still to become widespread. The scientists are judged\nbasing on the number of peer-reviewed papers they publish, therefore\ninvesting the time solely to offer the documentation is difficult. The\ndocumentation should include the actual mathematical equations and\ntheory behind the software, figures documenting the scientific results\nas well as code listings and usage examples. The target audience may\nhave a strong background in science, computer science, both or neither.\n",
   "duration": 1454,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/beth-aitman-before-the-docs-writing-for-user-interfaces.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "Good documentation is important, but it should be your last resort. You\nneed to help users before they reach the docs - in the user interface\nitself.\n\nIn this talk, I'll discuss:\n\n-  strategies for writing microcopy when you\u2019re short on space\n-  what to explain in the UI, and what to save for the documentation\n-  how to pick the right style of embedded help\n-  what makes a great error message (and a terrible one)\n\n... with plenty of real-world examples of doing it right and wrong.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "Good documentation is important, but it should be your last resort. You\nneed to help users before they reach the docs - in the user interface\nitself.\n\nIn this talk, I'll discuss:\n\n-  strategies for writing microcopy when you\u2019re short on space\n-  what to explain in the UI, and what to save for the documentation\n-  how to pick the right style of embedded help\n-  what makes a great error message (and a terrible one)\n\n... with plenty of real-world examples of doing it right and wrong.\n",
   "duration": 1555,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/chris-ward-documenting-your-story-crafting-a-good-presentation.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "Whilst not a part of the core documentation of projects, presentations\nand delivering them to the public are an essential part of spreading the\nword about what you do.\n\nThey need to be as equally consistent with your messaging and style\nguides, get to a key point effectively and also allow the presenter to\ninject some personality.\n\nThis is especially hard with technical projects where the 'story' is\neither hard to explain or can't just end up sounding like a sales pitch.\n\nIn this presentation I will explore and explain my experiences as an\nadvocate for several open source projects, audience reactions to those\npresentations and how I have iterated my presentations in sync with\nchanges to product and branding.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "Whilst not a part of the core documentation of projects, presentations\nand delivering them to the public are an essential part of spreading the\nword about what you do.\n\nThey need to be as equally consistent with your messaging and style\nguides, get to a key point effectively and also allow the presenter to\ninject some personality.\n\nThis is especially hard with technical projects where the 'story' is\neither hard to explain or can't just end up sounding like a sales pitch.\n\nIn this presentation I will explore and explain my experiences as an\nadvocate for several open source projects, audience reactions to those\npresentations and how I have iterated my presentations in sync with\nchanges to product and branding.\n",
   "duration": 713,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/christina-elmore-all-roads-might-not-lead-to-docs.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "Whilst not a part of the core documentation of projects, presentations\nand delivering them to the public are an essential part of spreading the\nword about what you do.\n\nThey need to be as equally consistent with your messaging and style\nguides, get to a key point effectively and also allow the presenter to\ninject some personality.\n\nThis is especially hard with technical projects where the 'story' is\neither hard to explain or can't just end up sounding like a sales pitch.\n\nIn this presentation I will explore and explain my experiences as an\nadvocate for several open source projects, audience reactions to those\npresentations and how I have iterated my presentations in sync with\nchanges to product and branding.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "Whilst not a part of the core documentation of projects, presentations\nand delivering them to the public are an essential part of spreading the\nword about what you do.\n\nThey need to be as equally consistent with your messaging and style\nguides, get to a key point effectively and also allow the presenter to\ninject some personality.\n\nThis is especially hard with technical projects where the 'story' is\neither hard to explain or can't just end up sounding like a sales pitch.\n\nIn this presentation I will explore and explain my experiences as an\nadvocate for several open source projects, audience reactions to those\npresentations and how I have iterated my presentations in sync with\nchanges to product and branding.\n",
   "duration": 1841,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/diana-potter-screencasting-101.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "As a writer, it's been tough for me to admit that not everyone wants to\nread my carefully written documentation. While people will read, not\neveryone learns by reading the docs. Since my goal is to make sure my\ndocumentation can meet as many learning styles as possible, that has\nmeant spreading my documentarian wings and bridging out from only\nwriting the docs into recording them as well.\n\nPart of my documentation journey has been learning how to create\nscreencasts and I want to share that knowledge with everyone. From\npicking the right topics, to outlining, to writing a script (yes I\npromise, there is still writing involved), to how to record your audio\nand video, I'll cover it all. You don't need to be a professional voice\nactor or videographer to create a screencast, even a writer can create\nsomething wonderful.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "As a writer, it's been tough for me to admit that not everyone wants to\nread my carefully written documentation. While people will read, not\neveryone learns by reading the docs. Since my goal is to make sure my\ndocumentation can meet as many learning styles as possible, that has\nmeant spreading my documentarian wings and bridging out from only\nwriting the docs into recording them as well.\n\nPart of my documentation journey has been learning how to create\nscreencasts and I want to share that knowledge with everyone. From\npicking the right topics, to outlining, to writing a script (yes I\npromise, there is still writing involved), to how to record your audio\nand video, I'll cover it all. You don't need to be a professional voice\nactor or videographer to create a screencast, even a writer can create\nsomething wonderful.\n",
   "duration": 633,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/elijah-caine-how-to-write-an-email.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "Nobody loves email. Nobody really even likes email. In fact email can\ntotally suck and it is here to stay. Despite how we feel about it, we\nhave to deal with email almost every single day. Fortunately we can\nimprove email as a whole by learning how to write email that sucks just\na little bit less -- not that you write bad emails.. this talk is for\nyour... friend. Yeah, this talk is for your friends that really need to\nsetup up their email game.\n\nIn addition to email this talk will explore some fundamental\nmisunderstandings that people have with modes of online communication\nand how to correct these misunderstandings. Like how to craft a good\nTweet, Facebook Post, and Instant Messaging interaction.\n\nThis is not meant to be a tutorial but rather a conceptual guide for how\nto think about on-line communication and how to correct some common\nfaults we share as members of the on-line community. The Internet isn't\ngoing away anytime soon, and the amount we communicate over it is not\ngoing to diminish anytime soon either. This talk attempts to teach one\nhow to make digital communication as painless as possible.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "Nobody loves email. Nobody really even likes email. In fact email can\ntotally suck and it is here to stay. Despite how we feel about it, we\nhave to deal with email almost every single day. Fortunately we can\nimprove email as a whole by learning how to write email that sucks just\na little bit less -- not that you write bad emails.. this talk is for\nyour... friend. Yeah, this talk is for your friends that really need to\nsetup up their email game.\n\nIn addition to email this talk will explore some fundamental\nmisunderstandings that people have with modes of online communication\nand how to correct these misunderstandings. Like how to craft a good\nTweet, Facebook Post, and Instant Messaging interaction.\n\nThis is not meant to be a tutorial but rather a conceptual guide for how\nto think about on-line communication and how to correct some common\nfaults we share as members of the on-line community. The Internet isn't\ngoing away anytime soon, and the amount we communicate over it is not\ngoing to diminish anytime soon either. This talk attempts to teach one\nhow to make digital communication as painless as possible.\n",
   "duration": 1654,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/emilie-boillat-whatchamacallit-controlled-vocabularies-for-technical-writers.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "An everyday dilemma in technical communication: What do you call that\n\u201cthing\u201d? Whether you ask developers, marketing folks or users, you often\nget very different views.\n\nAlong with user interfaces, documentation helps all stakeholders align\ntheir mental model of a product. Terminology plays a key role, and a\ncontrolled vocabulary is an ace up the technical writer's sleeve.\n\nControlled vocabularies are basically lists of concepts and the\nrelationships between them. Beyond consistent naming, they are about\nstructuring, categorizing and retrieving content. For example, you can\nuse a vocabulary as a basis for documentation plans, tables of content,\na help site's navigation, search filters, or even to organize test\ncases.\n\nIn this talk, I will share ways to create and maintain various types of\nvocabularies, and explain what each type is useful for. You can start\nwith a flat list of terms and expand it into a glossary, a thesaurus, a\ntaxonomy, or even a full-fledge ontology.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "An everyday dilemma in technical communication: What do you call that\n\u201cthing\u201d? Whether you ask developers, marketing folks or users, you often\nget very different views.\n\nAlong with user interfaces, documentation helps all stakeholders align\ntheir mental model of a product. Terminology plays a key role, and a\ncontrolled vocabulary is an ace up the technical writer's sleeve.\n\nControlled vocabularies are basically lists of concepts and the\nrelationships between them. Beyond consistent naming, they are about\nstructuring, categorizing and retrieving content. For example, you can\nuse a vocabulary as a basis for documentation plans, tables of content,\na help site's navigation, search filters, or even to organize test\ncases.\n\nIn this talk, I will share ways to create and maintain various types of\nvocabularies, and explain what each type is useful for. You can start\nwith a flat list of terms and expand it into a glossary, a thesaurus, a\ntaxonomy, or even a full-fledge ontology.\n",
   "duration": 1885,
   "language": "eng",
   "recorded": "2015-08-31",

writethedocs-eu-2015/videos/florian-scholz-jean-yves-perrier-gardening-open-docs.json

@@ -1,7 +1,6 @@
 {
-  "abstract": "With about 1000 different editors each month, the Mozilla Developer\nNetwork (MDN) documentation Web site for Open Web technologies is a\ntrafficked wiki with edits of all kind of quality: perfect text from\nseasoned professional writers to rough notes by teen-aged technology\nlearners.\n\nIn this talk, we are going to explore how to keep this doc garden clean,\nhow the diversity of editors influence its evolution, and how we find\nour way through treacherous jungles to well-maintained royal gardens.\n\nThis is about improving quality, working with diverse communities,\nfostering innovation, and carnivorous plants.\n",
   "copyright_text": null,
-  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2015/speakers/\n\nSlides: http://www.writethedocs.org/conf/eu/2015/schedule/\n\nFollow us on Twitter @writethedocs\n\nJoin our mailing list http://writethedocs.us11.list-manage.com/subscribe?u=fcfe905987123983cc93c7a46&id=e2e27d6167",
+  "description": "With about 1000 different editors each month, the Mozilla Developer\nNetwork (MDN) documentation Web site for Open Web technologies is a\ntrafficked wiki with edits of all kind of quality: perfect text from\nseasoned professional writers to rough notes by teen-aged technology\nlearners.\n\nIn this talk, we are going to explore how to keep this doc garden clean,\nhow the diversity of editors influence its evolution, and how we find\nour way through treacherous jungles to well-maintained royal gardens.\n\nThis is about improving quality, working with diverse communities,\nfostering innovation, and carnivorous plants.\n",
   "duration": 1570,
   "language": "eng",
   "recorded": "2015-08-31",