A changelog records meaningful changes by version and date. Each release section should show what was added, fixed, or removed in words readers understand.
What You Need to Know
Use headings for versions, lists for individual changes, and time for dates when appropriate. Avoid publishing only internal ticket numbers with no explanation.
The goal is not to collect as many tags as possible. Pick the element that best describes what the content really is.
Example: See It in Action
Add this example to the appropriate part of a practice HTML page. Read each line before you open the page in your browser.
This is a short HTML fragment. To try it as a webpage, put it inside the body element of a complete HTML document.
<article>
<h1>Website Changelog</h1>
<section>
<h2>Version 1.2</h2>
<time datetime="2026-10-18">October 18, 2026</time>
<ul>
<li>Added a photo gallery.</li>
<li>Fixed a broken link.</li>
</ul>
</section>
</article>
Let’s Understand the Example
- Article marks a piece that could make sense on its own, such as a news post or recipe.
- An h1 introduces the main subject of the page. Use the heading level for structure rather than font size.
- Section groups content around a shared topic and usually has a heading.
- Datetime gives a date or time in a machine-readable form, separate from the friendly text shown to visitors.
You should see distinct list items. Ask whether their order carries meaning: if the order matters, use an ordered list; otherwise use an unordered list.
What Should You See?
The page should display “Website Changelog” as a heading, followed by its related content. Change the heading text and refresh the browser to see the result.
Read only the headings, from top to bottom. Do they tell a sensible story? If not, move sections or choose levels that match the content.
Try It Yourself
- Add a Version 1.3 section with two understandable changes.
- Save your changes, open or refresh the page, and compare the result with the original example.
- Tell a friend what your change did. If you are not sure, undo it, refresh the page, and compare.
Common Beginner Mistakes
- Listing changes as vague words like fixes without saying what improved.
- Avoid picking tags just for their default bold, italic or spaced appearance. Use CSS for presentation.
Key Takeaways
- A changelog records meaningful changes by version and date.
- Article marks a piece that could make sense on its own, such as a news post or recipe.
- Use headings for versions, lists for individual changes, and time for dates when appropriate. Avoid publishing only internal ticket numbers with no explanation.