IP Library Granted Patent US 10,185,559
Granted Patent B2
US 10,185,559 · App. 15/308,575 · Granted Jan 22, 2019

Documentation notification

Inventors: Daniel Schreiber (Yehud, IL); Shimon Cherny (Yehud, IL); Effi Bar-Shean (Yehud, IL)
Assignee: ENTIT SOFTWARE LLC
G06F8/73G06F11/3668G06F17/30011G06F17/30368G06F17/30864
View Patent ↗
Loading inventors, assignments & file history…
Monitor This Case
Get email alerts when status or documents change.
Order Certified Copies
Most orders are placed with the USPTO same day — all within 24 business hours.
Order via The Patent Place →
Pre-filled with this patent's details
Quick Facts
Patent No.
US 10,185,559
App. No.
15/308,575
Granted
Jan 22, 2019
Kind
B2
Abstract

In one implementation, a record associated with an element of an application is maintained and a notification is generated when the record indicates a lack of documentation.

Claims (58)

1. A method of tracking documentation comprising:

maintaining, by a processor of a computing device, a plurality of records of a plurality of elements of an application in a database, wherein each of the records contains information related to one of the elements and an identifier indicating a status of documentation of the element;

receiving a list of the elements of the application;

analyzing, by the processor, the records of the elements listed in the list to identify a first identifier of a first record having a status that indicates a lack of documentation of a first element;

based on the status that indicates the lack of documentation of the first element, providing, by the processor, a notification to a tracking tool to cause the tracking tool to document the first element and create a bug based on the first element;

changing, by the processor, the status of documentation in the first identifier of the first record;

cause the bug of the tracking tool to be maintained based on the notification, the bug being a tracking tool record associated with a documentation task for the first element associated with the notification;

create a screenshot based on a document object model associated with the first element; and

provide the screenshot to the tracking tool to associate the screenshot with the bug via an attachment functionality of the tracking tool.

2. The method of claim 1 , comprising:

providing a coverage report based on the plurality of records in the database, the coverage report to indicate the first element lacks documentation.

3. The method of claim 2 , wherein the coverage report is provided based on one of a schedule, a continuous development cycle, a test stage, and a modification to the application.

4. The method of claim 1 , further comprising:

searching the database to determine that the first identifier of the first record indicates that the first element is associated with an undocumented element class.

5. The method of claim 1 , comprising:

receiving traffic based on an execution of the application;

recording information of the first element when the first element is maintained; and

notifying the tracking tool of maintenance of the element to create the bug.

6. The method of claim 1 , further comprising:

when one of the elements listed in the list is undocumented and not found in the records, adding an identifier associated with the undocumented element to the records and assigning the undocumented element for a documentation creation.

7. A system comprising:

a processor; and

a memory storing instructions that when executed cause the processor to:

maintain records of elements of an application, wherein each of the records contains information related to one of the elements and an identifier indicating a status of documentation of the element;

receive a list of the elements of the application;

analyze the records of the elements listed in the list to identify a first identifier of a first record having a status that indicates a lack of documentation of a first element;

generate, based on the status that indicates the lack of documentation of the first element, a notification to a tracking tool to cause the tracking tool to document the first element of the application and create a bug based on the first element;

change the status of documentation in the first identifier of the first record;

cause the bug of the tracking tool to be maintained based on the notification, the bug being a tracking tool record associated with a documentation task for the first element associated with the notification;

create a screenshot based on a document object model associated with the first element; and

provide the screenshot to the tracking tool to associate the screenshot with the bug via an attachment functionality of the tracking tool.

8. The system of claim 7 , wherein the notification causes at least one of a verification instruction to verify documentation of the first element and a report instruction to produce a documentation coverage report to identify that the first element is missing documentation.

9. The system of claim 7 , wherein the instructions are to cause the processor to:

execute a test on the application via a testing tool; and

capture traffic from the application based on a rule for capturing the traffic,

wherein the records associated with the elements of the application are maintained based on the captured traffic.

10. The system of claim 7 , wherein each of the records of the elements comprises a data structure to contain the identifier, a display name of the element, a context of the element, a document object model of the element, and documentation of the element.

11. The system of claim 7 , wherein the instructions are to cause the processor to:

attach the snapshot of the first element to the documentation task of the tracking tool to cause the tracking tool to document the first element of the application.

12. The system of claim 7 , wherein the instructions to cause the processor to:

when one of the elements listed in the list is undocumented and not found in the records, add an identifier associated with the undocumented element to the records and assign the undocumented element for a documentation creation.

13. A non-transitory computer readable storage medium comprising a set of instructions that when executed causes a processor resource to:

maintain a plurality of records of a plurality of elements of an application, wherein each of the records contains information related to one of the elements and an identifier indicating a status of documentation of the element;

receive a list of the elements of the application;

analyze the records of the elements listed in the list to identify a first identifier of a first record having a status that indicates a lack of documentation of a first element;

based on the status that indicates the lack of documentation of the first element, generate a notification to a tracking tool to cause the tracking tool to document the first element and create a bug based on the first element;

change the status of documentation in the first identifier of the first record;

cause the bug of the tracking tool to be maintained based on the notification, the bug being a tracking tool record associated with a documentation task for the first element associated with the notification;

create a screenshot based on a document object model associated with the first element and

provide the screenshot to the tracking tool to associate the screenshot with the bug via an attachment functionality of the tracking tool.

14. The medium of claim 13 , wherein the set of instructions is to cause the processor resource to:

when one of the elements listed in the list is undocumented and not found in the records, add an identifier associated with the undocumented element to the records and assign the undocumented element for documentation creation; and

when one of the elements listed in the list is found in the records and the record associated with the element has a status that indicates a lack of documentation, assign a writer to maintain the documentation and generate the notification to the tracking tool.

15. The medium of claim 13 , wherein the set of instructions is to cause the processor resource to:

crawl the application to obtain the elements; and

maintain the plurality of records of the elements in a database, each of the plurality of records to include a document object model.

16. The medium of claim 15 , wherein the set of instructions is to cause the processor resource to:

cause the snapshot to attach to the documentation task of the tracking tool, the documentation task to be a maintenance action associated with the first element.

Assignments (8)
RELEASE OF SECURITY INTEREST REEL/FRAME 044183/0718 Recorded Feb 2, 2023
From: JPMORGAN CHASE BANK, N.A.
To: MICRO FOCUS LLC (F/K/A ENTIT SOFTWARE LLC); BORLAND SOFTWARE CORPORATION; MICRO FOCUS (US), INC.; SERENA SOFTWARE, INC; ATTACHMATE CORPORATION; MICRO FOCUS SOFTWARE INC. (F/K/A NOVELL, INC.); NETIQ CORPORATION
Reel/Frame 062746/0399 →
RELEASE OF SECURITY INTEREST REEL/FRAME 044183/0577 Recorded Feb 2, 2023
From: JPMORGAN CHASE BANK, N.A.
To: MICRO FOCUS LLC (F/K/A ENTIT SOFTWARE LLC)
Reel/Frame 063560/0001 →
CHANGE OF NAME Recorded Aug 8, 2019
From: ENTIT SOFTWARE LLC
To: MICRO FOCUS LLC
Reel/Frame 050004/0001 →
SECURITY INTEREST Recorded Oct 11, 2017
From: ENTIT SOFTWARE LLC; ARCSIGHT, LLC
To: JPMORGAN CHASE BANK, N.A.
Reel/Frame 044183/0577 →
SECURITY INTEREST Recorded Oct 11, 2017
From: ATTACHMATE CORPORATION; BORLAND SOFTWARE CORPORATION; NETIQ CORPORATION; MICRO FOCUS (US), INC.; MICRO FOCUS SOFTWARE, INC.; ENTIT SOFTWARE LLC; ARCSIGHT, LLC; SERENA SOFTWARE, INC.
To: JPMORGAN CHASE BANK, N.A.
Reel/Frame 044183/0718 →
ASSIGNMENT OF ASSIGNOR'S INTEREST Recorded Jun 9, 2017
From: HEWLETT PACKARD ENTERPRISE DEVELOPMENT LP
To: ENTIT SOFTWARE LLC
Reel/Frame 042746/0130 →
ASSIGNMENT OF ASSIGNOR'S INTEREST Recorded Jan 11, 2017
From: HEWLETT-PACKARD DEVELOPMENT COMPANY, L.P.
To: HEWLETT PACKARD ENTERPRISE DEVELOPMENT LP
Reel/Frame 041337/0001 →
ASSIGNMENT OF ASSIGNOR'S INTEREST Recorded Jan 11, 2017
From: SCHREIBER, DANIEL; CHERNY, SHIMON; BAR-SHE'AN, EFFI
To: HEWLETT-PACKARD DEVELOPMENT COMPANY, L.P.
Reel/Frame 041335/0986 →
Continuity (1)
Related Publication 20170060577A1 · Mar 2, 2017
Cited By (1)
US 12,306,822