Work Samples
This page highlights my work in information architecture, content engineering, technical writing, and software development. The samples demonstrate my ability to solve complex problems, architect scalable documentation systems, and communicate technical concepts effectively.
Case studies
Strategic projects in content architecture, automation, and documentation systems.
Content migration to DITA CCMS
- Overview: Migrated 30,000+ topics from legacy documentation sites into a DITA-based CCMS, unifying product content and versioning.
- Role: Led migration strategy, built automation scripts, and designed scalable processes.
- Challenges: Complex legacy structures, diverse versioning, and minimizing manual cleanup.
- Solution: Automated content conversion and DITA map creation with Python and XSLT, built a version diff tool to upload only changed topics between versions, and accelerated delivery with AI-assisted coding.
- Impact: Dramatically reduced manual post-migration cleanup, improved content reuse, and enabled reliable cross-product navigation.
- Learn more: Lessons Learned in an AI-Assisted Content Migration on the Cisco Innovation blog.
Heretto Sitemap Governance
- Overview: Improved DITA CCMS sitemap integrity by leading governance and process alignment initiatives.
- Role: Led policy creation, stakeholder alignment, and process improvements.
- Challenges: Drift between staging and production sitemaps, inconsistent merging practices, and risk of content misalignment.
- Solution: Cleaned up and synchronized sitemaps, introduced conditional processing to safely merge references, authored a sitemap governance policy to standardize practices.
- Impact: Increased release predictability, reduced rework, and ensured long-term platform stability.
Technical Writing
Technical documentation samples for DevOps engineers, system administrators, cloud architects, SREs, and developers. Some of the pages are hosted on the Internet Archive and can take up to 10 seconds to load.
Procedural
This is one of several topics in a section on configuring Mirantis Kubernetes Engine (MKE) to use NGINX Ingress Controller. I collaborated closely with the feature developer, who provided me with the necessary information to draft the articles. Together, we refined the content, ensuring its comprehensiveness. After undergoing technical writer and developer review, the content was published and has remained largely unchanged since that time.
Configure Prometheus to scrape MSR metrics
Serving as the primary software developer in the creation of this feature, I acted as my own SME in the documentation process. I documented the configuration procedure through a combination of referencing my development notes and working with other developers to ensure that the documentation would work across orchestration platforms. The final draft went through both developer and technical writer reviews.
Conceptual
Already in publication when I started at Mirantis, I reworked this page over the years to survey evolving feature offerings and an expanding set of platforms on which the software could run. Updates to this overview received SME, engineering manager, and technical writer reviews prior to publication.
Reference
Mirantis Secure Registry 3.0 system requirements
This documentation outlines the essential system resource requirements and recommended allotments for running MSR 3.0. I first received the necessary information from the development team, which I organized and presented in draft form. To ensure accuracy and clarity, the draft underwent thorough editing and approval processes led by another writer and the development team. Subsequently, valuable feedback from customers and the support team was collected, and I incorporated their input into the current version of the documentation.
API
Mirantis Kubernetes Engine 3.6.2 API documentation
Revitalized the API documentation by migrating from Swagger to Redoc to enhance the overall presentation. Created an OpenAPI specification from the Golang codebase for each release and integrated it into the Sphinx-based documentation site.
Developed comprehensive API documentation for a cloud services platform utilizing the Apache CloudStack API. Created a user-friendly site using the Slate static site generator and GitHub Pages. Implemented a custom Javascript script to convert the API documentation from JSON to Markdown, ensuring a smooth and accurate transition between the data format and the markup language.
Troubleshooting
With extensive involvement in testing the Mirantis Migration Tool (MMT), I collaborated with another writer to create a comprehensive troubleshooting section for the MMT documentation, from which this page is drawn. Working closely with developers and the QA team, we documented detailed troubleshooting steps for different problem scenarios encountered during MMT testing. As users reported issues with the tool, we continuously expanded and enhanced the troubleshooting section to address emerging challenges. Taking the lead in drafting the additional content, I ensured its accuracy and clarity, which was further refined through reviews by a technical writer and SMEs.
Release Notes
Mirantis Secure Registry 2.9.1 release notes
Authored release notes encompassing product enhancements, issue resolutions, and security updates. Collaborated with ticket owners in Jira to create initial drafts for each release note, ensuring accurate and comprehensive coverage. Coordinated with a technical writer and the engineering team lead to review and edit the collection of release notes, incorporating their feedback and suggestions. Iteratively refined the drafts based on the review process until the release notes received final approval.
Software Development
Select software projects in Go and Python, highlighting my coding skills and technical experience.
Go
Developed a Prometheus exporter specifically designed for Docker registries, enabling the exposure of essential metrics such as repository and tag counts. This exporter serves as a valuable tool for monitoring and collecting key information from Docker registries, facilitating better visibility and analysis of repository and tag data.
Created a fork of an existing RethinkDB exporter, expanding its functionality by incorporating additional metrics for the current_issues table and table sizes. Additionally, implemented comprehensive unit testing to ensure the reliability and accuracy of the exporter. This enhanced version of the exporter provides improved monitoring and analysis of RethinkDB deployments.
Python
Developed a command-line interface (CLI) application that enables users to search for and replace text within multiple files in a given directory. This application provides a convenient and efficient way to perform bulk text replacements, saving time and effort when working with large sets of files.