Scaling Documentation Deployment Through CI/CD Automation

Enterprise Secure File Transfer Platform (GoAnywhere)

Overview

The documentation system for an enterprise secure file transfer product was tightly coupled and manually deployed. This created friction across engineering, documentation, and release workflows.

I led the redesign of the documentation architecture and deployment pipeline to align documentation with engineering CI/CD processes.

Before: Monolithic & Manual

Most user guides for this software product were:

• Contained within a single MadCap Flare project
• Stored on a single Git branch
• Manually built and manually distributed for developer review

Limitations:

• No ability to maintain documentation for past releases
• No versioned builds by branch
• No automated publishing
• Documentation reviews required manually attaching outputs to Jira tickets
• High review friction between writers and developers

Old Review Process

1. Make changes in MadCap Flare
2. Push changes to Git
3. Build output locally
4. Upload generated output to Jira
5. Manual back-and-forth review in Jira

This model prevented CI/CD adoption and did not scale with product growth.

Strategic Goals

• Align documentation with software release workflows
• Enable branch-based documentation builds
• Reduce review friction for developers
• Modularize documentation architecture
• Automate the documentation publishing process

Actions Taken

1. Cross-Functional Discovery

• Partnered with project managers and prior documentation owners to define requirements
• Collaborated with DevOps to design an automated build and publishing strategy

2. Architectural Refactor

• Separated guides into modular MadCap Flare projects
• Created one Git repository per guide
• Structured repositories to support independent automation

This eliminated the monolithic constraint and enabled scalable CI/CD workflows.

3. CI/CD Implementation

• Designed Jenkins workflows that triggered builds by Git branch
• Configured automatic job creation based on properly named branches
• Automated output publishing to Artifactory
• Enabled developers to pull documentation artifacts directly into local environments

This allowed documentation to integrate directly into the broader software publishing process.

New Process

1. Push changes to Git
2. Jenkins automatically builds documentation output
3. Output is published to Artifactory
4. Developers review documentation directly within their existing tooling
5. Documentation can be programmatically included in software builds

Documentation was no longer an isolated asset — it became part of the release pipeline.

Impact

• Eliminated manual build and upload steps
• Reduced documentation review friction
• Improved developer experience by allowing reviews within familiar tooling
• Enabled branch-based documentation versioning
• Created scalable automation across multiple guides
• Reduced operational overhead for release cycles

Most importantly, documentation became aligned with engineering infrastructure instead of operating outside it.

Additional Applications of this System

Enterprise File Transfer Platform (FileCatalyst)

Documentation was:

• Maintained manually in HTML files
• Stored in multiple locations
• Duplicated and inconsistently versioned
• Lacked source control

I:

• Consolidated documentation into version-controlled repositories
• Standardized content structure
• Implemented modular repositories per guide
• Applied the same Jenkins-based CI/CD publishing model

Result: Versioned, automated, scalable documentation aligned with release processes.

Secure File Transfer Platform (Globalscape)

I inherited:

• A corrupted documentation repository with structural instability
• Upcoming release deadlines

I:

• Rebuilt documentation architecture from the ground up
• Re-established a clean repository structure
• Implemented modular repos and CI automation
• Stabilized documentation ahead of active releases

Result: Polished end-user documentation with modular, versioned, automated repositories that are easy to maintain and deploy in sync with software releases.

Strategic Significance

This initiative demonstrates:

• Documentation systems thinking
• Cross-functional leadership
• Infrastructure-level improvements
• Developer experience optimization
• Scalable automation design

Rather than focusing solely on content quality, I focused on improving how documentation is built, versioned, reviewed, and released.

That shift transforms documentation from a support artifact into a release-aligned system component.