Skip to main content

What is the Documentation Manager?

Documentation gets written all over the platform. The Data Explorer keeps a document about a master data record or a data item, Projects keeps the design notes and evidence of each project, Integration keeps the guide to each connected system, and your team writes its own guides, notes and runbooks. All of these documents live in the platform's documentation service. The Documentation Manager puts them in one place, so you can answer questions like:

  • Where did we write down how the gas curves are built?
  • Which documents mention molecule_user?
  • What changed in the onboarding design since last week, and who changed it?
  • Do we have the German version of this guide yet?

Throughout these pages we follow Northgate Energy, a fictional gas and power trader. Priya Shah looks after its market data and keeps the team's runbooks and curve guides up to date.

The Documentation Manager with a guide open


Key ideas​

IdeaWhat it means
DocumentOne page of documentation: markdown text, a link to a web page, or JSON shown with a template
ScopeThe topic a document belongs to, such as guides, runbooks or object. Documents are grouped by scope
EntityWhat the document is about within its scope, such as a record id (ICE.NDEX.TTF) or a subject (curves)
NameThe document's own name, such as about or gas-curve-build
KeyScope, entity and name together, written scope:entity:name. With the language, the key identifies a document
LanguageThe language the document is written in (en, de, fr ...). A document can have a version in each language
TitleThe name shown in lists. When a document has no title, its name is shown
VersionEvery save keeps the previous text as an older version you can look at, compare and restore
DocumentationWhere a document is kept: Ours (your own, private), Common or Public (shared with every client)

What you get​

Part of the screenWhat it is for
Summary cardsHow many documents, scopes and languages there are, how many are about platform records, and how many changed in the last 30 days
FiltersChoose the documentation, find by title, name, scope, entity or tag, search the text inside the documents, and narrow to a scope, kind or language
Documents listThe documents grouped by scope, with the newest saves easy to spot
The open documentThe document as the portal shows it, with its key, language versions, tags and when it was saved, and the buttons to edit, see versions, copy or move, download and delete
Home page tasksFind documentation and Write a document

The extension adds Documentation to the Manage menu.


Where next​