Changelog Article
Definition
A changelog article is a running log of all changes made to a product, API, or system over time, typically organized by date or version number in reverse chronological order. Unlike individual release notes for a specific version, a changelog provides a continuous historical record. Changelogs are standard in software development, open-source projects, and API documentation, following conventions like 'Keep a Changelog' (keepachangelog.com). Categories typically include Added, Changed, Deprecated, Removed, Fixed, and Security.
Why It Matters
Changelogs establish trust and transparency with users and developers. A well-maintained changelog signals that a product is actively maintained and that the team respects users by communicating clearly. For developers integrating an API, the changelog is essential for staying current with breaking changes and deprecations. For AI chatbots, having the changelog in the knowledge base enables the bot to answer questions about change history, such as 'When was X feature added?' or 'Were there any API changes in January?'
How It Works
Changelogs are maintained as a single document (often a Markdown file like CHANGELOG.md in code repositories) or as a dedicated web page in documentation. Each entry includes the version/date, a categorized list of changes, and optionally links to related issues, pull requests, or documentation. The 'Keep a Changelog' standard recommends maintaining an 'Unreleased' section for upcoming changes. Automated tools like conventional commits and semantic versioning can partially automate changelog generation from commit messages.
Changelog Timeline
AI-powered search with semantic understanding across all content
Resolved article rating submission not persisting on mobile browsers
Introduced content versioning with full diff view and restore capability
Improved content freshness scoring algorithm and staleness notifications
Real-World Example
A 99helpers customer building a developer platform adds their API changelog to the knowledge base. When developers using the AI chatbot ask 'Did the authentication endpoint change recently?' or 'When was webhooks support added?', the chatbot retrieves the relevant changelog entries and provides accurate dates and descriptions. This reduces developer support tickets about API versioning by 40%.
Common Mistakes
- ✕Mixing user-facing and technical changes without clear separation — developers and end users need different levels of detail
- ✕Using vague language like 'various improvements' — every change should be specifically described
- ✕Forgetting to document breaking changes prominently — breaking changes need clear warnings and migration guidance
Related Terms
Release Notes
Release notes are structured documentation that communicates what changed in a new version of a product, including new features, improvements, bug fixes, and known issues.
Knowledge Base Article
A knowledge base article is a single piece of content within a knowledge base — covering one topic, question, or procedure in depth. Articles are the atomic unit of a knowledge base, and their quality, structure, and searchability directly determine how useful the knowledge base is for both human readers and AI retrieval systems.
Content Versioning
Content versioning is the practice of tracking changes to knowledge base articles over time — storing previous versions so that edits can be reviewed, rolled back, or compared. It ensures content integrity, supports audit requirements, and enables teams to recover from accidental changes or incorrect updates.
API Documentation
API documentation is a technical reference that explains how to integrate with and use an application programming interface, including endpoints, parameters, authentication, and code examples.
Help Center
A help center is a publicly accessible support hub — typically branded and hosted at help.company.com — that contains the knowledge base, AI chat, and support contact options. It is the central self-service destination for customers seeking assistance, and its quality directly affects support ticket volumes and customer satisfaction.
Ready to build your AI chatbot?
Put these concepts into practice with 99helpers — no code required.
Start free trial →