This article describes where and how to author documentation in Enlite.
Create a new documentation space
In Enlite, you author a documentation in Documentation Spaces – these are spaces dedicated to authoring. The content in these spaces is not directly visible by your end users.
To start working on your first document, simply create a new documentation space by using the Create New... menu item from the Documentation menu in the left hand upper corner, and select either Documentation to create a completely blank documentation, or Documentation Template if you have already created a template and want to use that.
Create a page
Once you've created a documentation space, you can get started on writing your docs.
To create new pages, click the Create page button on the top-left of the screen. New pages are created as children of the page where you are when you click Create page.
Collaborate on content
Enlite is focused on collaboration, so there are a number of ways you can notify other people about content that may be of interest to them:
- Share a link to a page via email (see the Confluence docs)
- Mention a user when you write a page or comment (see the Confluence docs)
- Like a page, or comment (see the Confluence docs)
- Watch pages to get email updates whenever a page is updated (see the Confluence docs)
Write your docs
The editor is what you'll use to create and edit your docs. You can enter content as you would in a Word document, apply formatting, and attach other content and files to the page.
For more information on the editor, see the Confluence documentation.
Use Enlite's advanced functionality
Enlite integrates a range of Confluence add-ons to add functionality required for an effective techdoc authoring process. There is already a body of documentation for these add-ons – the links are in the table below.
Please be aware that the functionality of the add-ons as documented in these links may differ slightly from their implementation in Enlite.
|Key feature||Description||Documentation link|
|Templating||Create re-usable templates of single pages or entire page hierarchies||Enlite|
|Version management||Manage documentation in multiple versions, to align your documentation with product releases||Scroll Versions|
|Variant management||Create multiple variants of documentation for different products||Scroll Versions|
|Workflows||Use workflows to manage even the most complex of reviewing and approval processes||Scroll Versions and Comala Workflows|
|Translation management||Maintain multiple languages in one documentation space, and translate content directly in Enlite or using a translation management system||Scroll Translations|
Next step: publish your work
Once you're done authoring your documentation, you can publish it to a publication space before making it available to your content consumers.