1. STAEDEAN documentation guidelines and processes
  2. Documentation processes
  3. Flows

Prepare for publishing
Activity Flow

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.

Technical writer Technical writer Start Start Put flow elements in the right sequence Put flow elements in the right sequence The flow element sequence is a somewhat hidden but very important feature. It determines the sequence in which the flow elements are added to the publications.The flow element sequence is by default the sequence in which the elements are added to the flow. So, it is not the sequence as shown in the flow design!Usually, this is not the required sequence. If you publish content, the flow elements are shown in the sequence in which these are sorted. This results in, for example, the last activity shown first, and the first activity shown last. That’s not what you want. Usually, you want the elements to be shown/ordered in a logical sequence, that reflects the sequence of elements in the flow design.So, before publishing, always change the flow element sequence to reflect the flow design in a logical way. Procedure 1. Click Business process modeling. 2. Click Business processes. 3. In the tree, select 'the desired business process'. 4. Click the Flow tab. 5. Click View details. 6. Click the Elements tab. 7. In the list, find and select the desired element. 8. Click Move down. Note: You can move several elements at once. 9. In the list, find and select the desired element. 10. Click Move up. Note: You can move several elements at once. Put the business processes to be published in scope Put the business processes to be published in scope If you publish documentation to a website, only the business processes that are 'In scope' are published. So, before you publish documentation to the website, make sure all business processes that you want to publish are 'In scope'. Procedure 1. Click Business process implementation. 2. Click the Scope definition tab. 3. Click Define scope. 4. In the tree, select 'a business process'. 5. Click In scope. Note: If a business process must not yet be published, put it 'Out of scope'. 6. Close the page. Publish documentation to Word Publish documentation to Word Before you publish documentation, always check the spelling and grammar.To do a thorough spelling and grammar check on the documentation as created in RapidValue, publish the documentation to Word. Procedure 1. Click Business process modeling. 2. Click Publish. 3. Click Process specification. 4. In the Business processes field, select 'In scope'. Note: Usually, you only do a spelling and grammar check on the documentation that you actually publish. Therefore, you select the option 'In scope'. if desired, you can also choose 'All'. 5. In the See also field, select 'Details'. 6. Leave the other parameter fields as is. See picture. 7. Expand the Details section. 8. Select Yes in the Include flow summary field. 9. In the Include flow details field, select 'Details'. 10. In the Sub flow field, select 'Details'. 11. Leave the other details fields as is. See picture. 12. Click OK. 13. Sub-task: Download document from share. 14. Click Share. 15. Click the Documents tab. 16. In the list, select the applicable document. 17. Click Download. Check and correct spelling and grammar Check and correct spelling and grammar Before you publish documentation, always check the spelling and grammar. To check the spelling and grammar, use the generated and downloaded business process specification document. To check the spelling en grammar, you can use: The Spelling&Grammar check of Word. An external tool, like Grammarly. Important: Make the corrections in RapidValue and not in the document!! 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). Make the spelling and grammar corrections on the product VM. End End

Activities

Name Responsible Description

Put flow elements in the right sequence

Technical writer

 		The flow element sequence is a somewhat hidden but very important feature. It determines the sequence in which the flow elements are added to the publications.
The flow element sequence is by default the sequence in which the elements are added to the flow. So, it is not the sequence as shown in the flow design!
Usually, this is not the required sequence. If you publish content, the flow elements are shown in the sequence in which these are sorted. This results in, for example, the last activity shown first, and the first activity shown last. That’s not what you want. Usually, you want the elements to be shown/ordered in a logical sequence, that reflects the sequence of elements in the flow design.
So, before publishing, always change the flow element sequence to reflect the flow design in a logical way.

Put the business processes to be published in scope

Technical writer

 		If you publish documentation to a website, only the business processes that are 'In scope' are published. So, before you publish documentation to the website, make sure all business processes that you want to publish are 'In scope'.

Publish documentation to Word

Technical writer

Before you publish documentation, always check the spelling and grammar.

To do a thorough spelling and grammar check on the documentation as created in RapidValue, publish the documentation to Word.

Check and correct spelling and grammar

Technical writer

Before you publish documentation, always check the spelling and grammar.

To check the spelling and grammar, use the generated and downloaded business process specification document.

To check the spelling en grammar, you can use:
  • The Spelling&Grammar check of Word.
  • An external tool, like Grammarly.
Important: Make the corrections in RapidValue and not in the document!!

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). Make the spelling and grammar corrections on the product VM.

Activities

Name Responsible Description

Put flow elements in the right sequence

Technical writer

 		The flow element sequence is a somewhat hidden but very important feature. It determines the sequence in which the flow elements are added to the publications.
The flow element sequence is by default the sequence in which the elements are added to the flow. So, it is not the sequence as shown in the flow design!
Usually, this is not the required sequence. If you publish content, the flow elements are shown in the sequence in which these are sorted. This results in, for example, the last activity shown first, and the first activity shown last. That’s not what you want. Usually, you want the elements to be shown/ordered in a logical sequence, that reflects the sequence of elements in the flow design.
So, before publishing, always change the flow element sequence to reflect the flow design in a logical way.

Put the business processes to be published in scope

Technical writer

 		If you publish documentation to a website, only the business processes that are 'In scope' are published. So, before you publish documentation to the website, make sure all business processes that you want to publish are 'In scope'.

Publish documentation to Word

Technical writer

Before you publish documentation, always check the spelling and grammar.

To do a thorough spelling and grammar check on the documentation as created in RapidValue, publish the documentation to Word.

Check and correct spelling and grammar

Technical writer

Before you publish documentation, always check the spelling and grammar.

To check the spelling and grammar, use the generated and downloaded business process specification document.

To check the spelling en grammar, you can use:
  • The Spelling&Grammar check of Word.
  • An external tool, like Grammarly.
Important: Make the corrections in RapidValue and not in the document!!

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). Make the spelling and grammar corrections on the product VM.
Related to Notes

Prepare for publishing