API: Difference between revisions

Revision as of 10:47, 7 August 2020

Revision as of 11:50, 7 August 2020

Line 158:

Documentation is crucial for the development and maintenance of applications using the API.<ref name="DekelHerbsleb9">{{Cite journal |last1=Dekel |first1=Uri |last2=Herbsleb |first2=James D. |date=May 2009 |title=Improving API Documentation Usability with Knowledge Pushing |journal=Institute for Software Research, School of Computer Science |citeseerx=10.1.1.446.4214}}</ref>

API documentation is traditionally found in documentation files but can also be found in social media such as blogs, forums, and Q&A websites.<ref name="ParninTreude11">{{Cite journal |last1=Parnin |first1=Chris |last2=Treude |first2=Cristoph |date=May 2011 |title=Measuring API Documentation on the Web |url=https://www.xmedo.com/measuring-api-documentation-web/ |journal=Web2SE |pages=25–30 |doi=10.1145/1984701.1984706 |isbn=9781450305952 |access-date=22 July 2016}}</ref>

Since API documentation is primarily a source of reference information, it needs to be easily searchable and is therefore web-based.<ref name="ITCQF">{url=http://itcqf.org/wp-content/uploads/2020/06/ITCQF_Syllabus_v2_0Jun2020.pdf|pages=17 |access-date=17 June 2020}</ref>

Traditional documentation files are often presented via a documentation system, such as Javadoc or Pydoc, that has a consistent appearance and structure.