Branching Strategies for Documentation

NeoArc Studio stores all content as files in Git, which means you can apply any branching strategy to your documentation. The right choice depends on your team size, release cadence, and how documentation relates to your code releases.

Feature Branch Strategy

The most common approach for documentation teams. Create a branch for each piece of work, review it, and merge.

How It Works

Branch Naming Conventions

Consistent naming helps teams understand what each branch contains.

When to Use Feature Branches

Trunk-Based Development

For teams that prefer continuous delivery: commit small changes directly to main, publish frequently.

How It Works

When to Use Trunk-Based

GitFlow for Documentation

For teams that align documentation releases with software releases.

How It Works

Maintain parallel branches for different purposes.

Release Documentation Workflow

When to Use GitFlow

Multi-Version Documentation

Some products maintain documentation for multiple versions simultaneously. NeoArc supports this through branch-based versioning.

Version Branches

Managing Cross-Version Changes

When a fix applies to multiple versions.

Combined Code and Documentation

When documentation lives in the same repository as code, align strategies.

Choosing a Strategy

Consider these factors when selecting a branching strategy.

This documentation site uses a feature branch strategy with pull request review, balancing review rigour with publishing velocity.

Next Steps