patjouk / wtd-2016

Contains the documentation patterns I have presented at the "Write the Docs Europe" in 2016.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Improving API-Documentation with Meaningful Names

This repostory collects several patterns for specifiying API-operations. To find matching patterns for your operation, use the gitHub-search function the verb from the operations name, e.g. "send" from "sendMessage(...)". This approach uses the linguistic concept of thematic grids and roles to improve the completeness of API-documentation.

Read about the Theoretical Background

  • VerbNet is the empirical basis of this approach and has been exteneded for its application to API-documentation.
  • The basic approach is described in a research paper by Jan Christian.
  • The empirical foundation can be found in Jan Christian's doctoral thesis (in german).

About

Contains the documentation patterns I have presented at the "Write the Docs Europe" in 2016.

License:Apache License 2.0