![]() Mirabel's power is to see what is there, and that is exactly the Mirabel is the character Mirabel Madrigal from the 2021 Disney movieĮncanto. We named this system "Project Mirabel", reflecting a practice of naming internal projectsĪfter characters from animation (we have Baymax and Voltron as notable examples). More expansive set of features for exploring and reporting on ServiceNow's large andĬorpus of product and internal documentation. ![]() Working with XML data and the BaseX XQuery engine as a powerful butĮasy-to-implement and easy-to-deploy infrastructure component, established the basis Short time and, by taking advantage of the general facilities of XQuery as a language Story of how we developed the validation data capture and reporting tools we needed This paper is a description of the technical details of the resulting Mirabel system Reporting ability did not exist before the start of fixit week. Validation errors so that they could plan and direct the fix up work most effectively.Īddition, we needed to capture validation results over time to then document and reportįixup achievements over the course of fixit week and beyond. Tools and infrastructure for Product Content, needed to supply managers with data To support this task the Product Content Engineering team, which develops and maintains In an attempt to pay down this accumulated technical debt. In February of 2022 Product Content decided to hold a "fixit week" where all authoringĪctivity would be paused and writers would instead spend their time fixing errors Schematron rules developed over the those eight years, reflecting editorial and terminologyĬoncerns, markup usage rules, and content details, such as leading and trailing spaces During thisĬontent accumulated hundreds of thousands of instances of various errors, as identified ![]() ![]() Years, during which time ServiceNow has experienced explosive growth. This content has been under active development in its current DITA form for about Versions at any given time, where each version has its own set of topics and maps. Product Content organization, spread around the globe. Sequences and hierarchies for publication. Table of Contents How We Built Project Mirabel The Starting Point: Git and OxygenXML From Ad-Hoc To Service, Phase 1 Validation Dashboard Implementation, Phase 2: Dark Night of the Implementor Validation Dashboard Implementation, Phase 3: Concurrency and Job Control Additional Features: Fun With XQuery New Requirements: Analytics and Metrics Reporting Project Mirabel Components and Architecture Managing Concurrency Managing Updating Operations Automated Testing Deployment Web Application Processing DITA Without DTDs Capturing and Reporting Link-Related Information: Where Used Indexes Doc-to-Bundle Map Construction Content Preview: Rendering Formatted DITA With Minimum Effort Conclusions and Future WorkĮach version of ServiceNow's primary product, ServiceNow Platform, is documented byĬollection of about 40,000 DITA topics, organized into about 40 different "bundles",īundle is a top-level unit of publishing, roughly corresponding to a major componentīundles are DITA maps, which use hyperlinks to organize topics into Representing non-trivial hyperdocuments, all within the span three weeks. Platform for general reporting and exploration over large and complex sets of DITA Large sets of DITA documents, growing from a simple reporting utility to a multi-function Mirabel, for capturing and reporting on the results of applying Schematron validation Describes the organic development of a multi-function XQuery-based system, Project
0 Comments
Leave a Reply. |