To Do or Not To Do: Distill crowdsourced negative caveats to augment api documentation
Sign Up to like & getrecommendations! Published in 2018 at "Journal of the Association for Information Science and Technology"
DOI: 10.1002/asi.24067
Abstract: Negative caveats of application programming interfaces (APIs) are about “how not to use an API,” which are often absent from the official API documentation. When these caveats are overlooked, programming errors may emerge from misusing… read more here.
Keywords: distill crowdsourced; negative caveats; api documentation; augment api ... See more keywords
Improving access to API documentation for developers with Docs‐as‐Code‐as‐a‐service
Sign Up to like & getrecommendations! Published in 2018 at "Proceedings of the Association for Information Science and Technology"
DOI: 10.1002/pra2.2018.14505501171
Abstract: Web Application Programming Interfaces (APIs) provide the connective tissue that developers need to integrate Internet services and create “software‐as‐a‐service” (SaaS) applications. To learn an API's usage, developers often turn to their web browsers to access… read more here.
Keywords: docs code; code; api documentation; service ... See more keywords
“I just looked for the solution!”On Integrating Security-Relevant Information in Non-Security API Documentation to Support Secure Coding Practices
Sign Up to like & getrecommendations! Published in 2022 at "IEEE Transactions on Software Engineering"
DOI: 10.1109/tse.2021.3094171
Abstract: Software developers build complex systems using plenty of third-party libraries. Documentation is key to understand and use the functionality provided via the libraries’ APIs. Therefore, functionality is the main focus of contemporary API documentation, while… read more here.
Keywords: information; api documentation; security relevant; security ... See more keywords