jan-christian-krause-using-meaningful-names-to-improve-api-documentation.json

{
  "abstract": "Interaction between incorporated software-systems is often realized via\napplication programming interfaces (APIs). The API-documentation\nexplains how to use the API. If it misses important information, serious\nmisunderstandings between the API\u2019s consumer and provider can be the\nconsequence.\n\nI my talk I will show how meaningful names in the source-code can help\nfinding gaps in the API-documentation. My findings base on my\nproject-experiences and a cross-sectional study of a corpus of more than\n186.000 web service- operations. I would like to share the 20\ndescription-patterns for API- documentation I found so far. They provide\ndetailed recommendations description of specific operations. The talk\ncloses with a comparison of classical \u201eswagger-like\u201c API-documentation\nwith the presented approach.\n",
  "copyright_text": null,
  "description": "Full talk description: http://www.writethedocs.org/conf/eu/2016/speakers/#speaker-eu-2016-jan-christian-krause\n\nFollow us on Twitter @writethedocs\nJoin our next events: http://www.writethedocs.org/",
  "duration": 846,
  "language": "eng",
  "recorded": "2016-09-18",
  "related_urls": [
    {
      "label": "Conference schedule",
      "url": "http://www.writethedocs.org/conf/eu/2016/schedule/"
    },
    {
      "label": "Speaker information",
      "url": "http://www.writethedocs.org/conf/eu/2016/speakers/#speaker-eu-2016-jan-christian-krause"
    }
  ],
  "speakers": [
    "Jan Christian Krause"
  ],
  "tags": [],
  "thumbnail_url": "https://i.ytimg.com/vi/YOBVWfmRHzc/maxresdefault.jpg",
  "title": "Using meaningful names to improve API-documentation",
  "videos": [
    {
      "type": "youtube",
      "url": "https://www.youtube.com/watch?v=YOBVWfmRHzc"
    }
  ]
}