To get the documentation published properly, follow the procedures in this section.


Technical writer Technical writer Start Start Prepare for publishing

Prepare for publishing

Several preparations are required before you can publish documentation:

  • Put the flow elements in the right sequence.
  • Put the to-be-published business processes in scope.
  • Do a spelling and grammar check.

Publish documentation and task guides to LCS

Publish documentation and task guides to LCS

When STAEDEAN releases a product version, the relevant task guides must be included in the release. This is done, using a library in the Business process modeler in LCS.
The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS.

This flow explains how to publish To-Increase documentation and task guides for D365 F&SCM to LCS.

Note: Usually, you develop the documentation of a STAEDEAN D365 F&SCM product on the product's environment (can be a test or demo environment). Publish documentation and task guides to LCS from the product VM.

Solve reference issues

Solve reference issues

A documentation solution can have reference solutions defined. Sometimes, due to changes, these references can be hidden.

Before exporting the documentation solution from the product VM, check the solution for (hidden) references and consolidate the solution.
You can use these RapidValue options to explore and solve reference issues:
  • View solution reference hierarchy
  • Consolidate solution

Export solution from product VM and import it on TI-10-DOCS VM

Export solution from product VM and import it on TI-10-DOCS VM

When you have done spelling and grammar corrections on the documentation, export the solution from the product VM and import it to the TI-10-DOCS VM.

Reasons:
  • Publishing to the docs.staedean.com website is done from the TI-10-DOCS VM.
  • The TI-10-DOCS VM serves as a documentation solutions repository.

Set up and maintain docs.staedean.com website

Set up and maintain docs.staedean.com website

To publish documentation to the website, the website setup must be up to date.

Note: Set up and maintain the to-be-published websites on the TI-10-DOCS VM! The current TI-10-DOCS VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/

Publish documentation to docs.staedean.com

Publish documentation to docs.staedean.com

This flow explains all activities to be done to publish STAEDEAN documentation for D365 F&SCM products to the docs.staedean.com/ website.

Note: Always publish the websites from the TI-10-DOCS VM!

Monitor published documentation

Monitor published documentation

When published to docs.staedean.com, you can monitor the:

  • Analytics of the documentation website.
  • Feedback on D365 F&SCM documentation.

End End

Activities

Name Responsible Description

Prepare for publishing

Technical writer

Several preparations are required before you can publish documentation:
  • Put the flow elements in the right sequence.
  • Put the to-be-published business processes in scope.
  • Do a spelling and grammar check.

Publish documentation and task guides to LCS

Technical writer

When STAEDEAN releases a product version, the relevant task guides must be included in the release. This is done, using a library in the Business process modeler in LCS.
The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS.

This flow explains how to publish To-Increase documentation and task guides for D365 F&SCM to LCS.

Note: Usually, you develop the documentation of a STAEDEAN D365 F&SCM product on the product's environment (can be a test or demo environment). Publish documentation and task guides to LCS from the product VM.

Solve reference issues

Technical writer

A documentation solution can have reference solutions defined. Sometimes, due to changes, these references can be hidden.
Before exporting the documentation solution from the product VM, check the solution for (hidden) references and consolidate the solution.
You can use these RapidValue options to explore and solve reference issues:
  • View solution reference hierarchy
  • Consolidate solution

Export solution from product VM and import it on TI-10-DOCS VM

Technical writer

When you have done spelling and grammar corrections on the documentation, export the solution from the product VM and import it to the TI-10-DOCS VM.

Reasons:
  • Publishing to the docs.staedean.com website is done from the TI-10-DOCS VM.
  • The TI-10-DOCS VM serves as a documentation solutions repository.

Set up and maintain docs.staedean.com website

Technical writer

To publish documentation to the website, the website setup must be up to date.

Note: Set up and maintain the to-be-published websites on the TI-10-DOCS VM! The current TI-10-DOCS VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/

Publish documentation to docs.staedean.com

Technical writer

This flow explains all activities to be done to publish STAEDEAN documentation for D365 F&SCM products to the docs.staedean.com/ website.

Note: Always publish the websites from the TI-10-DOCS VM!

Monitor published documentation

Technical writer

When published to docs.staedean.com, you can monitor the:

  • Analytics of the documentation website.
  • Feedback on D365 F&SCM documentation.