Cognitive process of creating software documentation during the software development life cycle using available REST API.
Publication Date: 2016-Mar-22
The IP.com Prior Art Database
Method of improving a process of creating software documentation during the software development life cycle using available REST API.
Page 01 of 3
Cognitive process of creating software documentation during the software development life cycle using available REST API .
Cooperation between the development team and the technical communication team might be hindered by multiple factors. As a result, product documentation might be incomplete or overdue. Frequent changes in the application source code related to the used parameters, REST API calls or commands can cause that related parts of documentation are outdated. Such documentation easily gets desynchronized as the software development process is dynamic and involves merging the work of many people.
Using an external plugin, for example a plugin dedicated to version control, we can monitor changes in the application source code and search for methods that we
want to have documented and validated. To extract these methods, we will use an annotation processor that will detect the controller, type of REST API method, and required parameters defined in the source code. Having the definition of these methods extracted, we will create a map which can be later on transformed into a DITA file.
Using a dedicated process that will continuously monitor source code changes, we
will extract methods annotated as REST API calls and create a multi-dimensional
map of methods. The map will consist of the name of the REST API call (in the example below it is /exampleQuery), the list of associated parameters, the type of the REST call. During the test phase, the expected retu...