Summary: this page describes how to use the Document-It feature.

Introduction

The Document-It feature allows you to add detailed documentation to a view and also to specific objects or nodes. This documentation is in addition to tags or comments that you can add to your views:

Adding documentation to views

In all views/modes, you can add one Document per node or group of nodes. It is also possible to add one Document per view.

To add a Document, first select the node you want to Document in the view, then use the left hand menu item:

If you want to add a Document at view level (i.e. for all the nodes in the view), click the Add a document view in the Investigate panel:

The document popup will be displayed - fill in the title, description (i.e. the text you want to add) and optionally a Tag. You can add tags that you have already created using the  icon in the left menu bar, or create the tags directly in the Document:

You can also choose a colour for your Document:

Click Save when complete:

The document is then minimized to the bottom left of the screen and can be re-displayed by clicking it:

Adding documentation to a group of nodes

When you add a Document to a group of nodes, the nodes that were selected will all be highlighted when the Document is redisplayed:

Updating or deleting existing documentation

Open the existing documentation, make your changes and then click Save:

Add new nodes/objects/groups of objects to an existing documentation 

You can add new nodes/objects/groups of objects to an existing documentation as follows:

Searching existing documentation

It is possible to use the global search function to search documentation that has already been added. See User Guide - Search for items.