Creating Changelog Posts
Master the art of writing effective changelog posts
Creating Changelog Posts
Learn how to create engaging and informative changelog posts.
The Changelog Editor
The editor supports rich text formatting:
Text Formatting
- Bold: Emphasize important information
- Italic: Subtle highlights
- Headers (H1-H6): Structure your content
- Links: Reference documentation or resources
Lists
- Bullet points for features
- Numbered lists for step-by-step instructions
- Nested lists for complex information
Media
- Upload images to showcase features
- Embed videos (if supported)
- Add code snippets
Post Fields
Title (Required)
- Clear and descriptive
- 50-100 characters ideal
- Include version number if applicable
Example: "Dashboard v2.0: Analytics and Reporting"
Content (Required)
- Explain what changed and why
- Include benefits to users
- Add screenshots for visual features
- Keep it concise but informative
Tags (Optional)
- Categorize your update
- Use consistently across posts
- Help users filter updates
Publishing Workflow
- Draft: Create your post
- Preview: Review how it looks
- Publish: Make it live
Best Practices
Do:
- Use clear, simple language
- Include visuals when possible
- Be specific about what changed
- Explain the benefit to users
- Publish regularly
Don't:
- Use jargon or technical terms unnecessarily
- Write walls of text
- Skip important details
- Publish incomplete information
- Forget to proofread
Post Visibility
Posts inherit visibility from their page:
- Public pages = Posts visible to everyone
- Private pages = Posts restricted by role