7  Project history

Changelog

A changelog is a plain text file that contains a record of what notable changes are made between versions of hardware. It includes new features, enhancements, bug fixes, and even minor tweaks. The keep a changelog website provides a detailed explanation of what a change log is (in the software case).

Changelogs are primarily intended for technical contributors and power users who need a detailed understanding of how the hardware has evolved over time.

Guiding Principles

  • Changelogs are for humans, not machines.

  • There should be an entry for every single version.

  • The same types of changes should be grouped.

  • Versions and sections should be linkable.

  • The latest version comes first.

  • The release date of each version is displayed.

  • Mention whether you follow Semantic Versioning.

  • Types of changes:

    • Added for new features.
    • Changed for changes in existing functionality.
    • Deprecated for soon-to-be removed features.
    • Removed for now removed features.
    • Fixed for any bug fixes.
    • Security in case of vulnerabilities.

Sources

Section 9.5, https://keepachangelog.com/en/1.1.0/

Release notes

Release notes detail the corrections, changes or enhancements (functional or non-functional) made to the service or product the company provides. They are are summaries of changelog made for target users and manufacturers. They usually come with new hardware release. Release notes can also contain test results and information about the test procedure. This kind of information gives readers of the release note more confidence in the fix/change done.

sources
Wikipedia, see also https://blog.releasenotes.io/changelog-vs-release-notes/
## Design choices
What were the decisions made in designing this hardware? Were other designs/options tried? please describe also what did not work.
This information may be included at different places in the documentation, it may be interesting to link them together, or find a way to make them discoverable in the documentation files, for instance using a specific text one can search for.

Sources

Section 9.3