Manual entries

Sometimes you want to announce updates, share news, or communicate changes that aren't tied to specific issues. Learn how to create manual changelog entries for these situations.

When to use manual entries

Announcement types

• Product updates: General product improvements
• Policy changes: Terms of service or privacy updates
• Infrastructure updates: Server or system improvements
• Team announcements: New team members or changes

Content examples

• New features: Features not tied to specific issues
• Improvements: General improvements and optimizations
• Bug fixes: Resolved issues not tracked as issues
• Maintenance: System maintenance and updates

Creating manual entries

Basic entry creation

1. Go to your project dashboard
2. Navigate to the Changelog section
3. Click "Create Entry"
4. Fill in the entry details:
   • Title: Clear, descriptive title
   • Description: Detailed explanation
   • Release date: When the update occurred
   • Tags: Categorize the entry
   • Featured: Highlight important entries

Entry details

• Title: Keep it concise but descriptive
• Description: Provide sufficient detail
• Release date: Set accurate release date
• Tags: Use consistent tagging system
• Featured status: Highlight important entries

Content guidelines

• Clear messaging: Use clear, understandable language
• User focus: Write for your end users
• Consistent tone: Maintain consistent voice
• Accurate information: Ensure information is correct

Entry types

Feature announcements

• New functionality: Announce new features
• Enhancements: Highlight improvements
• Integrations: New third-party connections
• Customizations: New customization options

Bug fixes

• Resolved issues: Fixed problems
• Performance improvements: Speed and efficiency gains
• Stability improvements: Reliability enhancements
• Security updates: Security-related fixes

Infrastructure updates

• Server improvements: Backend enhancements
• Performance optimizations: Speed improvements
• Scalability improvements: Better handling of growth
• Reliability improvements: Uptime and stability

Policy and legal

• Terms updates: Changes to terms of service
• Privacy updates: Privacy policy changes
• Security updates: Security policy changes
• Compliance updates: Regulatory compliance changes

Content formatting

Title format

• Consistent structure: Use consistent title format
• Action-oriented: Use action verbs when appropriate
• Clear and concise: Keep titles short and clear
• Descriptive: Include enough detail to understand content

Description format

• Structured content: Use consistent structure
• Bullet points: Use lists for multiple items
• Clear sections: Organize content logically
• User benefits: Focus on user value

Date formatting

• Consistent format: Use consistent date format
• Accurate dates: Ensure dates are correct
• Timezone consideration: Consider timezone differences
• Release timing: Publish at appropriate times

Entry management

Draft entries

• Save as draft: Save entries before publishing
• Edit drafts: Modify draft entries
• Review process: Review entries before publishing
• Approval workflow: Require approval for entries

Published entries

• Edit published: Modify published entries
• Version history: Track entry changes
• Unpublish: Remove entries from public view
• Archive: Move old entries to archive

Entry organization

• Categorization: Organize entries by type
• Tagging: Use tags for organization
• Search functionality: Enable entry search
• Filtering: Filter entries by criteria

Best practices

Content strategy

• Regular updates: Publish updates regularly
• Meaningful content: Only publish significant updates
• User value: Focus on user benefits
• Transparency: Be honest and transparent

Writing guidelines

• Clear language: Use clear, understandable language
• Consistent tone: Maintain consistent voice
• User focus: Write for your audience
• Accurate information: Ensure information is correct

Timing considerations

• Release timing: Publish when updates are ready
• User expectations: Meet user expectations
• Communication timing: Coordinate with other communications
• Regular schedule: Maintain consistent publishing schedule

Advanced features

Entry templates

• Standard formats: Use consistent entry formats
• Template library: Create reusable templates
• Custom templates: Create project-specific templates
• Template sharing: Share templates across projects

Entry automation

• Scheduled publishing: Schedule entries for future publishing
• Automated content: Generate content automatically
• Integration triggers: Publish based on external events
• Workflow automation: Automate entry creation process

Entry analytics

• View metrics: Track entry views
• Engagement metrics: Monitor user engagement
• Popular entries: Identify popular content
• User feedback: Collect entry feedback

Integration options

External tools

• Project management: Connect to project tools
• Development tools: Link to development systems
• Communication tools: Share entries via communication tools
• Analytics tools: Track entry performance

API access

• Programmatic creation: Create entries via API
• Bulk operations: Manage multiple entries
• Custom integrations: Build custom integrations
• Webhook support: Real-time entry notifications

Troubleshooting

Common issues

• Publishing problems: Issues with entry publishing
• Content formatting: Problems with content format
• Date issues: Incorrect date handling
• Permission errors: Access control problems

Resolution steps

1. Check content: Verify entry content
2. Review settings: Check entry settings
3. Test publishing: Try publishing process
4. Contact support: Get help if needed

Next steps

• [Roadmap setup] - Configure roadmap display
• [Publishing issues] - Move issues to changelog