Changelog

Keep your customers in the loop of what you're working on.

1. What is Changelog?

Not to reinvent the wheel, let's check Wikipedia:

A changelog is a log or record of all notable changes made to a project. The project is often a website or software project, and the changelog usually includes records of changes such as bug fixes, new features, etc.

Simply put, at ProdCamp changelog is a module that allows sharing a product's updates with its customer base.

2. How to make it public?

There are two ways of how to share your updates:

2.1 Share it on your roadmap

Creating a new changelog record will enable the section on your public roadmap (considering it's shared publicly).

2.2 Changelog embeddable widget

Alternatively, you can share your changelog in the embeddable widget.

To get the most out of it, use both: the changelog on the public roadmap and as an embeddable widget.

3. How to get started with Changelog?

Create a changelog record

To create a record, go to the Changelog section on the main menu and click on "New entry".

You can create drafts and publish them when the time comes.

PRO Tip: To make your changelog more alive, consider adding animated GIF images.

4. Embedding Changelog in your app

  1. Go to the products page and open your product.

  2. Head over to Widgets and click on the Generate button.

3. Click on the first section with code called "Widgets SDK installation kit", it will copy the text to the clipboard and place it inside the <body> tag on your page.

It will look similar to the following code

    ...
    <script>!function(t,e,a,n){function o(){if(!e.getElementById(a)){var t=e.getElementsByTagName(n)[0],o=e.createElement(n);o.type="text/javascript",o.async=!0,o.src="https://cdn.prodcamp.com/js/prdcmp-sdk.js",t.parentNode.insertBefore(o,t)}}if("function"!=typeof t.ProdCamp){var c=function(){c.args.push(arguments)};c.t="********",c.p="************",c.args=[],c.f=true,t.ProdCamp=c,"complete"===e.readyState?o():t.attachEvent?t.attachEvent("onload",o):t.addEventListener("load",o,!1)}}(window,document,"prodcamp-js","script");</script>
    ...
</body>

4. Init the changelog widget on the page.

<script>
    ProdCamp('initChangelog');
</script>

For example, here's what was needed to add a changelog button to our recent blog post:

<div style='display: flex; justify-content: center;'>
	<a data-prodcamp-changelog="true" href="#" class="button-copy primary-copy button-small-copy button-cta-first-copy w-button">PLEASE PLEASE PLEASE CLICK HERE</a>
</div>
...
<script>
    ProdCamp('initChangelog');
</script>

Thank you!

Feedback is much appreciated.

Check out our changelog:

Last updated