- 10 minutes to read

Document Profiles

New 7.11

Give every technical article, runbook, or design document in a category the same skeleton. A Document Profile is an ordered list of sections, called Parts, that an Article adopts. Shared sections such as a header, a Next Step block, or a copyright footer come from Snippets, and stay identical in every Article. The sections in between are left for each Article's author to write. Edit the profile once, and every Article using it shows the new structure.

  • ✅ Define an ordered structure once, reuse it across unlimited Articles
  • ✅ Mix fixed, shared sections with sections each Article fills in itself
  • ✅ Guarantee every Article using the profile has exactly one Main Body
  • ✅ Go from a saved profile to a new Article in one click
  • ✅ Start from a seeded, ready-to-copy example instead of a blank designer

Contoso O2C: invoice export troubleshooting in the editor without a profile, Document Profile set to Contoso Integration Runbook, Confirm Document Profile Change with Yes, the profile's sections with the old text in Overview and a Documentation health warning, the Owner and contacts section written, Save, View, and the Article read in the profile's order, animated walkthrough (7.12)
Animated walkthrough: an existing Article gets a Document Profile in its editor. Its text moves into the Main Body, the Required section is written, and after Save and View the Article reads in the profile's order: header, its own sections, footer.

Understanding Document Profiles

A Document Profile is an ordered list of Parts. Each Part is one of three kinds: a Snippet Part, a Content Part, or a Generated Part. The designer says it like this: Snippet parts are fixed reusable content; Content parts are editable placeholders filled in per Article; Generated parts are filled in by a generator (BizTalk) and locked for users. Two Content parts cannot be adjacent.

graph LR DocumentProfile[fa:fa-list-check Document Profile] Part1[fa:fa-lock Snippet Part: Header] Part2[fa:fa-pen Content Part: Main Body] Part3[fa:fa-lock Snippet Part: Footer] SnippetHeader[fa:fa-puzzle-piece Snippet: Standard Header] SnippetFooter[fa:fa-puzzle-piece Snippet: Standard Footer] DocumentProfile -- Part 1 --> Part1 DocumentProfile -- Part 2 --> Part2 DocumentProfile -- Part 3 --> Part3 Part1 -- Shows --> SnippetHeader Part3 -- Shows --> SnippetFooter

A Document Profile with three ordered Parts: a Snippet Part showing a standard header, a Content Part marked as the Main Body, and a Snippet Part showing a standard footer. A Generated Part would sit in the same list.

Concept Behavior
Part One section slot in a Document Profile, placed in order
Snippet Part A fixed, read-only section filled from a chosen Snippet
Content Part An editable section that each Article fills with its own text, with the full editor toolbar, including Insert Icon for inline Component Type icons (requires a Mapify license; see Writing a Profile-Based Article)
Generated Part New 7.12 A section a generator writes, such as Generate Articles from BizTalk, picked by its Section Key in the Snippet / Section column; it is locked for users (see BizTalk Document Profiles and Section Keys)
Main Body Exactly one Content Part, marked with a radio button, as the Article's own main text. When an existing Article starts using the profile, its current content is moved into the Main Body
Required A Content Part setting that marks a section every Article should fill in. An empty Required section doesn't block Save: the editor shows Documentation health warning: required section(s) without content: (names). Saving is still allowed.

Document Profile, Template, or Snippet?

All three help you write consistent Articles, but they work at different times:

Document Profile Template Snippet
What it gives an Article The section layout Starter text — for each Content Part when it uses a profile — plus tags and Custom Metadata One reusable block of content
When it applies Every time the Article is displayed Once, when the Article is created Every time the document is displayed
Editing it later Changes every Article using it Doesn't change Articles already created Changes every document that includes it

They combine: the profile owns the structure, a profile-based Template owns the starter text for each Content Part, and the Article is the instance. The seeded Standard Technical Base Template works this way on new installations (see Seeded Examples).

Designer Rules

The Document Profile can't be saved while any of these is broken:

Designer Rule What it prevents
Two Content Parts may not sit next to each other Two open-ended editable sections running together with nothing separating them
Every Snippet Part must reference a Snippet An empty, unresolvable section shipping to every Article that adopts the profile
A profile with any Content Part must have exactly one Main Body An Article with editable sections but no designated main text, and nowhere to put an existing Article's content when it starts using the profile
Every Generated Part needs a Section Key, and each Section Key may be used only once per profile New 7.12 A generated section the generator can't fill in, or two sections fighting over the same content

A Snippet used by more than one Part is only a warning: the designer says so, and you can still save.

Building a Document Profile

  1. Open the Document Profile designer — create a new Document Profile, or edit an existing one
  2. Add Parts in the order they should appear with + Snippet Part (choose the Snippet it shows, with a preview), + Content Part (an editable section with a name), or + Generated Part (pick the Section Key the generator fills in)
  3. Reorder Parts by drag and drop, or remove a Part you no longer need
  4. Mark exactly one Content Part as the Main Body with its radio button — the first Content Part added takes the mark by default; if that Part is later removed, the mark moves automatically to another Content Part
  5. Tick Required on each Content Part that every Article should fill in; an empty one shows a Documentation health warning in the editor, but doesn't block saving
  6. Save — the designer refuses the save until every rule above is satisfied

Document Profile Structure with Snippet and Content Parts, the Main Body radio button, a Required section, and the message Every Snippet part must reference a snippet (7.12)
Example of the Document Profile designer with Snippet Parts, a Content Part marked as Main Body, and drag handles for reordering. While a designer rule is broken, the yellow box says which.

Snippet Part editor showing the Snippet picker and a live preview (7.12)
Example of choosing a Snippet for a Snippet Part, with a preview of its content.

Start from a Copy

To build on an existing Document Profile, such as the seeded Standard Technical Article, click Clone in its editor header. The Duplicate Document Profile dialog suggests a Name: the original title with the date and time of the copy, such as Standard Technical Article (copy 2026-11-05 19:34). Replace it with a name your team recognizes and click Duplicate. The copy opens in its editor in the area you started from, Repository or Administration. It has the same Parts, ready to adjust, and Articles using the original are not affected.

Duplicate Document Profile dialog for Standard Technical Article with the suggested Name Standard Technical Article (copy 2026-11-05 19:34) and the Duplicate button (7.12)
Example of cloning a Document Profile: give the copy its own name before you click Duplicate.

From Profile to Article

A saved Document Profile is only a structure. It does its job once Articles use it:

flowchart LR Design[fa:fa-list-check Design and save the Document Profile] Add[fa:fa-square-plus Add Article using this Profile] Workspace[fa:fa-table-columns Composite workspace opens] Write[fa:fa-pen Write the Content Parts] Article[fa:fa-newspaper Profile-based Article saved] Read[fa:fa-book-open Readers see the composed document] Design --> Add Add --> Workspace Workspace --> Write Write --> Article Article --> Read Design -. Later profile edits apply live .-> Article style Design fill:#2678BD style Add fill:#E47528 style Workspace fill:#E47528 style Write fill:#E47528 style Article fill:#93d16d style Read fill:#3F827B

The path from a Document Profile to a published Article: design the structure (blue), create and write the Article (orange), save it (green), and read the composed result (teal). Later edits to the profile reach the Article without editing it.

Add an Article Using This Profile

Click Add Article using this Profile in the Document Profile's editor header. The Article editor opens with the profile preselected and the composite workspace ready: Snippet Parts are shown locked, and each Content Part is waiting for its text.

Document Profile editor header for the shipped Standard Technical Article with Mapify, Mermaid, View, the highlighted Add Article using this Profile button, Add Document Profile, and Clone (7.12)
The Add Article using this Profile button sits next to View, Add Document Profile, and Clone in the Document Profile editor. A shipped profile, like this one, has no Save; a profile of your own has Save next to Clone.

The same button is on the profile's reader page, and the same action is on its row Action menu on the Document Profiles overview.

Standard Technical Article Document Profile reader page with the Add Article using this Profile button highlighted (7.12)
The Add Article using this Profile button on the reader page of the seeded Standard Technical Article profile, next to Mapify, Mermaid, Edit, Print, and Download.

On the Articles overview, use With Document Profile… in the Add Article dropdown to pick a profile first. See Ways to Create an Article for every entry point and the profileId deep link.

Continue with Writing a Profile-Based Article to fill in the Content Parts and save.

Apply a Profile to an Existing Article

New 7.12 An Article you already wrote can use a profile too:

  1. Open the Article in the editor. Document Profile reads No profile (free-form Article).
  2. Choose the profile in Document Profile.
  3. In Confirm Document Profile Change, read Applying a Document Profile keeps the current text as the profile's Main Body section. Continue? and click Yes.
  4. The profile's sections appear: Snippet Parts locked, Content Parts editable, and the Article's old text in the Main Body. A Documentation health warning names each empty Required section.
  5. Write the sections you need, then click Save.

To move many Articles onto a profile at once, use With Selected > Apply Document Profile; see Move many Articles onto a Document Profile at once.

Profile Changes Are Live

When a Document Profile is edited, every Article using it shows the new structure immediately — the Articles themselves are never edited, only how they're composed for display changes.

Before you change or delete a profile, check its Usage panel in the editor, or the Dependency Impact view in the reader, to see which Articles are affected. Mapify also draws the Document Profile use as an edge between the profile and each of its Articles.

Seeded Examples

Nodinite installs a complete worked example with the database, ready to copy or study:

  • Five seeded Snippets: Standard Header, Standard Footer, Standard Copyright, Standard Next Step Section, and Standard Related Topics Section
  • A Standard Technical Article Document Profile, built from those Snippets around two Content Parts
  • A Standard Technical Base Template that uses that Document Profile and supplies starter text for its Overview and Details Content Parts, so new Articles start profile-based (new installations only; see Templates)

The Standard Technical Article profile has seven Parts, in this order:

# Part Kind Shows or holds
1 Standard Header Snippet Part std-header — Standard Header
2 Overview Content Part, Main Body The Article's own main text
3 Next Step Snippet Part std-next-step — Standard Next Step Section
4 Details Content Part Further text written per Article
5 Related Topics Snippet Part std-related-topics — Standard Related Topics Section
6 Standard Footer Snippet Part std-footer — Standard Footer
7 Copyright Snippet Part std-copyright — Standard Copyright

The two Content Parts are separated by a Snippet Part, as the designer rules require.

New 7.12 Nodinite also ships four BizTalk Document Profiles for Generate Articles from BizTalk; see BizTalk Document Profiles and Section Keys.

New 7.12 The seeded examples are marked Shipped by Nodinite. A shipped Document Profile and its Snippets are locked: they can't be edited or deleted, and every Nodinite upgrade updates them in place. In the designer, a shipped profile is read-only: parts can't be added, removed, reordered, or changed, and Title, Slug, and Tags are disabled. Preview of a Snippet Part still works. To customize the profile, click Clone to customize in the banner (or Clone) and adjust the copy. See Shipped by Nodinite.

Shipped by Nodinite banner with the Clone to customize button on the Standard Technical Article Document Profile (7.12)
The banner on a shipped Document Profile: it can't be edited or deleted, and Clone to customize gives you an editable copy.

Warning

Changes you made to the Standard Technical Article profile or its Snippets before 7.12 are overwritten by the upgrade. Clone them before you upgrade; see Shipped by Nodinite.

Standard Technical Article seeded Document Profile in the designer, read-only because it is shipped: no add buttons, drag handles, or remove buttons, and the Name, Snippet, Main Body, and Required fields greyed out; five Snippet Parts with Preview and open-Snippet buttons around the Overview (Main Body) and Details Content Parts (7.12)
The seeded Standard Technical Article profile: five Snippet Parts around the Overview (Main Body) and Details Content Parts.

Delete and Restore

Deleting a Document Profile hides its sections; restoring the Document Profile brings them back. A section an Article had already removed or discarded before the delete stays removed after a restore.

New 7.12 Document Profiles, like Articles, Snippets, and Templates, are user content: anyone with Modify on Articles can also Permanently Delete a Document Profile, live or deleted. Shipped Document Profiles are refused. See Permanently Delete on the Bulk Actions page.

Next Steps