How to update your help articles after every product release
Use the Handoff feature to identify product changes from GitHub commits and receive proposed documentation updates for relevant help articles.
Keeping your help documentation up-to-date with product changes is essential for providing accurate support to your users. This guide shows you how to use the Changes workspace to find product changes and update your help articles after your development team releases new features or updates.
Getting Started
-
Open Changes
Open the "Changes" workspace. -
Find and select a change
Find the change you want to document and select it. If the change doesn't need documentation, choose "Skip," select the reason it can be skipped and the Help Center scope, then confirm your decision. You can then move on to the next change. For more on the action bar and how to undo a decision, see What is the Changes workspace?. -
Choose a Help Center
If the change applies to more than one Help Center, select the Help Center you want to update.
Creating Documentation Proposals
-
Create documentation proposals
Plan the documentation proposals for the selected change. -
Review and edit proposals
Review each proposal and edit it if needed. -
Accept or discard proposals
Accept the proposals you want to keep and discard the ones you don't need.
Applying Updates
- Apply accepted changes
Apply your accepted proposals. This writes the accepted changes to the Help Center you selected. Undecided proposals stay open, so you can come back to them in a later pass.
After completing these steps, your help documentation will be updated to match the latest product release, ensuring your users always have accurate and current information.
