Guides and Tutorials

First Steps With Studio: Technical Documentation Tutorial

Updated: October 16, 2020

This tutorial offers a progressive and educative tour of what you can do to customize the Nuxeo Platform with Nuxeo Studio. It should be one of the first tutorials you do.

In this sample use case, we will use the Nuxeo Platform to manage technical documentation. It will be important to make it easy to differentiate draft documentation items from validated ones. We will implement the publishing logic using the Nuxeo Platform.

Here are a few rules we want to follow:

  • A technical documentation document is called a "documentation item". It can be a procedure, a notice or installation instructions.
  • When looking at a documentation item we should only display needed information, nothing else.
  • A documentation item is composed of an office file and a set of descriptive metadata.
  • All documentation items should be stored in one place. This means it should be easy to filter documents by metadata.
  • The document listing should display the useful metadata immediately.
  • A newly created document should be editable only by its creator until the validation workflow is started.
  • A workflow should be available to validate a document easily.
  • Publishing should automatic at the end of the validation workflow.

Here are the steps to follow:

We'd love to hear your thoughts!

All fields required