7. Documentation engineering and automation
This chapter develops the engineering detail behind Umbraco migration tooling, Figma retrieval, and documentation validation. The Writing examples show how source changes can be inspected in a rendered form.
7.1 Preserving content through migration
I investigated how to preserve content structure, authoring behavior, rendered output, and publication packaging during migration. I compared HTML, DITA, Markdown, and hybrid approaches, checked output against existing SOTI XSight help, and worked on static packages compatible with Pulse/WebHelp.
My checks cover notes and tips, title spacing, table widths and merged cells, image dimensions, icons, media folders, static assets, links, context help, search, and on-page navigation. I also examined how task sections such as About this task and Procedure translate into the target authoring model.
These details explain why migration is more than transferring prose. The structure and relationships must survive, and the rendered result must still function as help. The quality chapter retains the observations that informed this work.
7.2 Export configuration and publishing tools
I worked on build-numbered export folders and product/version-specific configurations to support multiple help releases. I shaped a publishing-tool interface for technical writers, with configurable access, export options, progress feedback, and a simpler page layout.
The interface makes a technically involved export easier for a writer to configure, run, and check.
My investigations included test-content cleanup, locating source HTML, reconciling SOTI Identity imports, comparing exporter packages, and inspecting current files.
7.3 Structured content transformations
I investigated table-formatting limitations in the DITA-OT Markdown pipeline and proposed three approaches: testing the markdown_github output, adding a lightweight Python post-processor, and considering a custom XSLT plugin for longer-term support.
I developed a Windows/Python utility and guide for finding images outside DITA figure elements. The tool follows map and topic references, offers a size filter and scan-only mode, and exports reports. Its desktop interface uses Tkinter and Python’s standard library.
I used nested and merged-table inventories to identify structures needing special attention during conversion and to guide transformation checks.
7.4 Human readable review interfaces
I explored rendered HTML comparisons so reviewers could inspect DITA changes without reading XML. The approach uses full-page previews, highlighted differences, and before-and-after views. The ten writing comparisons demonstrate this review approach on selected examples.
I explored an SME review interface with rendered content, comments, and possible visual editing to make technical review more accessible to colleagues.
Other review-related investigations counted ditamap-linked topics with substep elements, located file references and author history, and divided linked SOTI MobiControl 2026.1 topics among reviewers. These supporting utilities help define review scope and assignment but are not interchangeable with the authoring substitute tool.
7.5 Jira Figma and reporting integrations
I developed the Figma retrieval workflow around a recurring research problem: designs were spread across child and linked Jira issues. I worked on discovering relevant mockups, handling multiple frames, exporting images, and presenting them in a local browser interface.
My reporting experiments include a refreshable Aha workbook for the Technical Writing team, Excel/Jira Data Center guidance, ticket-status notifications, and commit-history analysis. I used an exported pivot as the starting point for a more useful refreshable view.
7.6 Repository based development
I collaborated with the Data Science team on Umbraco utilities and documentation-authoring tools, using GitHub Enterprise for shared code, change history, and review before Web-team acceptance or deployment.
7.7 Environment and server troubleshooting
I troubleshoot IIS hosting, rewrite and proxy rules, local services and ports, cache behavior, Umbraco previews and publishing, and metadata previews in Teams. I also investigate Ant transformations, Git access, SSH/RDP connections, networking, AI environments, and MCP integrations.
This troubleshooting keeps the authoring, review, and publishing workflow usable for the team.