Product

Documentation links in Marketing

The public release notes Productmind drafts for a Marketing release in Marketing sort what changed into three sections, and link each item to your documentation, so customers can read more about what they can now do. Each public release notes document of a Marketing release gets its own links, and its blog posts and customer emails link the same pages.

Key concepts

Sections. The notes list each item under New features (something customers couldn't do before), Improvements (something they had, made better) or Bug fixes (a problem that no longer happens). A section with nothing in it is left out. Notes drafted before the sections keep their own layout.

Read more. The line at the end of an item, linking up to two documentation pages. A blog post ends with a Read more section, and a customer email ends each item with a Read more line.

Published documentation. The pages links can point to: a website you added to the knowledge base, and docs a Knowledge Base sync brings in from a folder or file with a Published at address.

Productmind finds the pages for each item:

  1. the published documents linked to the features the item comes from: a feature attached to the Marketing release, or one its releases, feature requests or customer feedback lead to;
  2. otherwise, the published pages whose text is closest to what the item says, when they match it clearly.

Productmind never makes up a link. When no page matches, the item has no Read more line.

  1. Publish your documentation where customers can read it.
  2. Add it to the knowledge base: add the website, or set Published at on the folder a Knowledge Base sync brings in.
  3. Optionally, link each document to its feature, so the notes always link the right page.
  4. Draft the notes, a blog post or the customer emails.

Each public release notes document shows 1 item has no documentation link (or how many) above the document, listing them, and so does its publish dialog. It's a reminder, not a blocker: add a line such as Read more: [Page title](https://...) under an item yourself, or publish the page and draft again. A blog post with no Read more section says so when you approve it.

Last modified on