Documentation

The organization documentation overview is where you manage documentation templates and upload PDF documents.

Documentation templates

Documentation templates can be managed at both the organization and Workspace level. Organization templates can be shared with specific Workspaces. Templates provided by Deeploy are shared with all Workspaces by default.

Add a template

1. Navigate to the documentation page in your organization.
2. Select Add, choose a name, and add a description for the template.
3. Select Download to get a copy of the .csv template file. The template is pre-filled with example input.
4. Replace the example input with the questions you want to include in your documentation template. Optionally, assign a question to a category or add a subtitle.

info

If the category column is left completely empty, questions aren't grouped at all. If you leave the category column empty for only some questions, those questions are automatically grouped into a category called other.

Save the template file and upload it in the Add a template window. After selecting Save, the template is available for all use cases within the Workspace.

Provide Workspace access

Select Manage Workspaces access from the template's actions. Then select the Workspaces you want the template to be available for.

danger

Removing Workspace access deletes all templates from use cases in that Workspace, including any answers to the template questions.

Template state

You can deactivate documentation templates to manage changing compliance needs. Select Deactivate from the template's actions. Documentation based on deactivated templates is available in read-only mode in use cases, but can no longer be edited. To reactivate a template, select Activate from the template's actions.

A template can be deactivated at both the organization and Workspace level.

Delete a template

Select Delete from the template's actions. This action can't be reversed. Once a template is deleted, any documentation based on it in use cases is also removed.

PDF documentation

PDF documents can be shared with Workspaces and imported by use cases to be used as evidence for controls or to generate AI suggestions for documentation templates.

Upload a document

To upload a new document to your organization:

1. Navigate to the documentation page in your organization.
2. Select the PDF tab.
3. Select Upload.
4. Enter a name for your document.
5. Select the PDF file you want to upload.
6. Select Save.

note

Only PDF files smaller than 50 MB are accepted.

Edit a document

To modify an existing document:

1. Find the document in the documents list.
2. Select Actions next to the document.
3. Select Edit.
4. Update the name or upload a different file.
5. Select Save.

Provide Workspace access

Select Manage Workspaces access from the document's actions. Then select the Workspaces you want the template to be available for.

danger

Removing Workspace access deletes all imported documentation from use cases in that Workspace.

Download a document

To download a document:

1. Find the document in the documents list.
2. Select Actions next to the document.
3. Select Download.

Delete a document

To remove a document:

1. Find the document in the documents list.
2. Select Actions next to the document.
3. Select Delete.
4. Confirm the deletion.

danger

Deleting a document also removes it from any Workspaces and use cases that have linked it.