About us   |   Login   |   Register
 

 

Publish, share, and review your documentation

Publish, share, and review

LiveTechDocs lets your documentation team publish, share, and review their XML documentation in an efficient and user-friendly way.

You need to perform the following steps to get started after registration:

  • Create a project (or use the one created by default).
  • Add users, give them access to your project, and assign roles.
  • Upload your documentation XML file in the repository and generate the documentation.

That's it! From there, you can browse and review your documentation in our user-friendly interface

Roles and permissions

We implemented the roles most frequently used in technical documentation: reviewer, technical writer, illustrator, project manager, and administrator.

The following table gives an overview of the permissions associated to each role.

Permissions
Reviewer
Technical Writer
Project Manager
Administrator
Review the documentation
Add comments to the documentation
Upload the documentation
Re-generate the documentation
Edit the documentation
Set comment threads to fixed
Archive comment threads
Reopen fixed or archived comment threads
Access the Client Administration tab
Administrate projects
Administrate users
Administrate roles

Note: the Illustrator role will be available soon.