Browse Prior Art Database

Leveraging collaboration between code templates and code written using them Disclosure Number: IPCOM000247424D
Publication Date: 2016-Sep-07
Document File: 3 page(s) / 31K

Publishing Venue

The Prior Art Database


This article talks about leveraging collaboration between code templates and code written using them as an aid to the developer in writing software in an efficient manner

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 31% of the total text.

Page 01 of 3

Leveraging collaboration between code templates and code written using them

Every developer usually refers to some artifacts like article\blog\sample\tutorial (henceforth called resources) etc. while writing code. Its difficult to keep a track of all such references and hence the references can not be reused which result in reinventing the wheel i.e searching all over again the resources used during the last time coding was done. It is hard work for developer to scan and select resources that may be used to write code. It is usually inefficient for developers to go through the technical concepts and online resources again especially for the related topics that may have already been studied and referred.

Most importantly, the developers have to be vigilant about maintaining information around copyright of the code template that may have been referred to. Developers may refer to any code template from any resource and use it in the project. The legal and licensing regulatory requirements may force inclusion of any copyright info of such third party code template used.

Also a lot of times, the code template undergoes update or the resources in which it is contained under goes update for perhaps a better, more performing solution or technical relevance. There is usually no way for the developer to be made aware of such changes to reflect those back into the code. Thus, the developer cannot benefit from the latest updates.

More importantly, during code reviews, if these resources are presented to the reviewers, it can help a great deal for doing an effective code review as they can give a lot of perspective and information reliability of the code.

Many a time when developers look at such resources, code templates are plenty but a more exhaustive related code is always more helpful. But it is rare that these resources are connected to any code repositories or any comprehensive code samples.

Also, once developers look at these code templates in form of code snippets or understand technical concepts from resources, and translate them into written code, they are not very sure about the correctness from the code perspective. How far they have been true to the concepts and code snippets or how far they have digressed is always a useful feedback for developers. So there is a need to be able to some how share the code for review and share it with the community which comes to visits those resources in future since a lot more people are likely to visit these resources than wander about in code repositories.

To solve above issues there is proposed to achieve collaboration between the resources that contain the code templates to be used and the code written using it. It is proposed that from any given resource that has a usable code template, one can navigate to the code written using it, and also from the written code, one can always refer back to the resource that was used. Therefore, proposal is to leverage a two way connection between these t...