Documentation > Create your own template

Generate Documentation using your own template

Step by Step

Cloudockit generates detailed documentation of everything you have in your Cloud Environment, and also includes rich Visio diagrams. Wouldn’t it be nice to control the output document that Cloudockit generates? Change your logo, add text, remove sections, change colors…. You can do it all. Let’s see how.

There are two methods to customize the template. The method you choose depends on the type of customization you want to achieve:

  • Method 1 enables you to change the color, logo and styles but not the actual content of the template
  • Method 2 also allows you to change the actual content of the template (like removing some section or changing boilerplate text)

Method 1

First create a Word document containing your cover page (a good place to put your logo) and a table of contents. Adjust the Word styles to suit your needs (H1, H2, Normal, etc.). Everything after the Table Of Content will be removed during document generation and Cloudockit inserts its immediately after.

Method 2

We need to provide you with a base template with specific placeholders. Simply contact us at support@cloudockit.com.  Once you have open the document, you need to ensure that you can see the Developer Tab (I don’t see it):

As you can see in the Executive Summary section, the document is built with many Content Controls that are dynamically filled by Cloudockit when it generates the documentation. If you want to change the template, you can do as follow:  Change the look and feel of the document

As the template is a word document, the best way to change the look and feel of the document is to edit the Heading styles.  In order to do that, right click on the Heading and click on modify:

Then, you can change the color or styles as you want. You can also change the First Page of the document. For instance, you can change the colors and the logo:

Remove content

If you don’t need a specific section or content in a section, you can just remove it. For instance, if you don’t need the Web Site Diagnostics section, you can use the navigation Pane and delete it

If in this specific section, you want to remove only a specific line in the table, you can also do that.

Add content

You can also add content in the document. For example, if you don’t like the boilerplate text that is used in the document, you can edit it:

The last step before saving the update Template is to update the Table of Content. You must go on the Table of Content and right click and select update:

Warnings

Changing the Template can result in a generated document that is corrupted, so please ensure you read this:

  • Always update the Table of Content before saving the document
  • Proceed to small changes and try to generate the document and do other changes to ensure that you haven’t made any change that corrupt the document
  • Do not modify the structure of the document (like removing Content Control that are Placeholders)
  • Once you have changed the template, you will not get the new template stuffs so our advice is to keep the personalization minimal so that you can easily redo it if we provide a new template. **

This step is really mandatory as Cloudockit is using Table of Content to remove empty section. So if you don’t’ do that, you may have a corrupted document. Also, note that you cannot change the Table of Content like not displaying all the Heading levels otherwise it will corrupt the document. Use the template

Use your new template

Now that you have made the hard work, it’s time to use the template to generate a new document. To do that, click on the settings button of the Cloudockit Portal and go to the template tab. Click on browse and then select your template then click Generate!