Widenet Consulting
Automated Documentation Solution for an eCommerce Company
(Consultant | October 2015)

Dynamic documentation of an Enterprise eCommerce System

The system maps the behavioral and physical environment of importance to the eCommerce system. It includes structural models reflecting enterprise elements such as the code repository. The code repository is modeled from, top down: projects, to namespaces, to individual classes. Other mapped structures include data centers, hosts, databases, and applications. In addition, the model reflects behavioral elements such as transactions and user interactions.

As a map it is derived from concrete ties to elements in the preproduction environment. It uses a code-first paradigm rather than depending on design or planning documentation. The tool models the “as is” environment and retains a history of the “as was” environment.

A conceptual model is a model made of the composition of concepts, which are used to help people know, understand, or simulate a subject the model represents. Some models are physical objects; for example, a plastic toy model which may be assembled, and may be made to work like the object it represents. This model is rendered as a property graph rather than in plastic.

The Enterprise eCommerce System property graph is made accessible to eCommerce support staff and stakeholders through various views of the data rendered as diagrams and tables. The graph can answer common questions such as application dependency, where you can find the source code for a particular application, which aspects of the structural environment have changed from release to release.

In addition, the system provides a scalable platform for creating new documents, reports, and sources of insight into the eCommerce platform. Analysts can create ad-hoc queries and add documents to the set of diagrams produced by the tool.

If the document does not appear in the Google Embed, you can access it here.