Edit online

Propose Changes

Read time: 2 minute(s)

Besides the team of technical writers who have full write access to the documentation repositories, there may be other collaborators (e.g. subject matter experts) who have read access to the repository and sometimes want to propose changes.

The workflow for proposing changes to a repository usually works like this:
  1. Identify the Need for a Change

    The SME (subject matter expert) starts by reading the published output and thinking about what to change

  2. Click “Edit Online”

    They click on an "Edit online" link on the page they want to change

  3. Make the Edits

    Using the Oxygen XML Web Author the SME can make changes directly to the DITA topic—no need to download or clone the repository.

  4. Submit the Changes

    When they try to commit, Web Author automatically creates a pull request with their changes

  5. Review and Merge

    The technical writer reviews the change, improve the content if needed, and merges the pull request.

You can see this workflow presented in detail in the video below. Short on time? Jump straight to the demo section and see it in action.