Activities

Activity	Area	Description
Add product icon to website resources	Documentation	Each STAEDEAN product for D365 F&SCM, add a tile to the applicable pillar website setup. Each product tile has it's own icon. Ask the marketing department for the appropriate icon for the product tile.
Add release notes to Azure Storage	Documentation	Add the release note PDF files to the 'releasenotes' folder in Azure Storage. You can find the 'releasenotes' folder in the 'To-Increase Production' Azure environment, in the 'sadocswebsite' storage account, under 'Blob Containers' -> '$web'. You can do so, for example, using the Azure Storage Explorer:
Add tile for new D365 F&SCM product	Documentation	Each STAEDEAN product for D365 F&SCM has it's own tile in the applicable pillar website setup. When you add documentation for a new product, also add a new tile.
Apply video references	Documentation	You can apply a video reference in any text in your RapidValue solutions, like Description or Notes.
Approve published corporate library	Documentation	To make a published corporate library available for use by others, you must approve it. Note: You need admin rights for LCS to approve corporate libraries.
Check and correct spelling and grammar	Documentation	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.
Check if the approved corporate library is added to asset library	Documentation	If published and approved, the library must be available in the LCS project's Asset library. Check if this is the case.
Check published website	Documentation	If the updated documentation is published to Azure, check if the updates are shown properly on the documentation website. If you do not see the changes, use F5 to refresh the page. If this doesn't work, use Ctrl+F5. If you still do not see the updates, check if all updates are published properly and if the purge and refresh are done properly.
Consolidate solution	Documentation	In a solution, you can use elements from reference solutions. To consolidate the current solution, you can merge these elements into the current solution. So, you make these elements unique for the current solution. You can consolidate one reference solution at a time. If several reference solutions are available, carefully select which one to consolidate first. Duplicate elements If you consolidate a solution, duplicate elements can be found. So, elements from the reference solution can already exist in the current solution. You can define what action is taken if a duplicate is found: Keep both elements; the copied elements get a suffix Use destination element For each duplicate that is found, a task is created and assigned to the user who does the consolidation. Such a task describes the found duplicate and the action that is taken. You can use the task to check whether the right action is taken and to make changes, if required. Reference solutions As a result of the consolidation, the selected reference solution is removed from the reference solutions of the current solution. Note: In a reference solution, you can also use elements from another solution (which is a reference solution of your reference solution). You can have used such elements in your current solution. In this case, the reference solution of your reference solution is added as a reference solution to the current solution. Example: Solution 'Base' has a reference solution 'A'. Solution 'A' has a reference solution '1'. In solution 'Base', you have used a flow from solution 'A'. This flow in solution 'A' has an activity from solution '1'. If you consolidate solution 'A' into solution 'Base': Solution 'A' is removed as reference solution from solution 'Base'. Solution '1' is added as reference solution to solution 'Base'.
Create and download data file on product VM	Documentation	When the solution is exported to a content package, create a data file and download it to a local folder.
Create and estimate documentation work breakdown	Documentation	For each product increment, the technical writer creates a separate product backlog item. For each product backlog item, the technical writer creates the related work breakdown structure and estimates for the documentation work. So, the documentation work can be scheduled/picked up in the sprints of the related product team. The product increment document work breakdown is created: Based on the product increment release notes. In consultation with the product owner where needed. To set up documentation tasks in DevOps, it is best practice to: Copy release note section content to the related task. Add a textual reference to the related release notes section. If already clear, make notes on what must be done/changed/added to the documentation and where this must be done in the documentation. Of course, both the Budget (which is the estimate) and Remaining hours must be entered. On estimations, these two values must be the same.
Create documentation epic and features	Documentation	For each pillar/domain, the software development is managed in a separate DevOps project. The product owner provides: A documentation epic for each pillar/domain. In this epic, a documentation feature for each of the pillar/domain products.
Do triage of documentation feedback and estimate work	Documentation	The technical writer can receive feedback on documentation from the service department. Feedback on documentation can come from several sources, for example: Customer Partner Internal (STAEDEAN service or support colleagues) Bug solution (Code changes to solve a bug can require a documentation change) The technical writer assesses the feedback. If a documentation change is required, the technical writer creates a DevOps task with description and estimated time of the required work in number of hours. The documentation task is added to the appropriate product increment PBI.
Download and test websites locally	Documentation	On publishing the website (or a tile), the website content is added to a ZIP file. Download the ZIP file from D365 F&SCM and extract it. Test the published website locally before publishing it to the web!
Export business processes to LCS	Documentation	The product documentation and task guides, as created in RapidValue, serve as source for creating the library in LCS. To create a project library in the LCS Business process modeler, export the relevant business processes from RapidValue 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 to LCS from this environment! If you publish to LCS from another environment than the product's environment, the task guides are not published.
Export solution in product VM	Documentation	When you have done spelling and grammar corrections on the documentation, export the solution from the product VM. On export, a content package is created containing all solution elements.
Get release notes from product teams	Documentation	To update the release notes section on https://docs.staedean.com/, you need the latest release notes. Get the release notes from the product teams. Usually, you can find the release notes in the Files section of the applicable product team channel on Teams. Otherwise, contact the product owner. The release notes must be in PDF format. So, if the release notes are in Word format, open the document and save it as PDF file.
Get video embed code	Documentation	For a consistent look and feel, all videos must be embedded in the same way. To do so, get the embed code of the video from the video portal and edit it to resemble this embed code: <div style="width:560px; height:315px; position: relative; padding-bottom:0px"><iframe src="https://videos.staedean.com/v.ihtml/player.html?token=[token]&source=embed&photo%5fid=[ID]" style="width:100%; height:100%; position: absolute; top: 0; left: 0;" frameborder="0" border="0" scrolling="no" mozallowfullscreen="1" webkitallowfullscreen="1" allowfullscreen="1" allow="autoplay; fullscreen"></iframe></div> Where these variables represent the video specific values: [token] [ID] The quickest way to edit the embed code from the video portal is to replace the first tag with this tag: <div style="width:560px; height:315px; position: relative; padding-bottom:0px">
Import solution in TI-10-DOCS VM	Documentation	On the TI-10-DOCS VM, import the downloaded data file to have the latest version of the solution available for publishing to the website. The current TI-10-DOCS VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/
Inform the team that the corporate library is available	Documentation	If a library is published and approved in LCS, notify the team. The new library must be included in the official release of the product.
Inform the team that the website is updated/published	Documentation	When the documentation is published to docs.staedean.com, inform the team.
Maintain and prioritize overall documentation backlog	Documentation	Product management, in consultation with technical writers and product owners, prioritizes the overall documentation work. Usually, prioritizing the documentation work is done once per product increment. Preferably, prioritizing is done before or early in the product increment.
Make backup of website setup	Documentation	When you have made changes to the website setup, make a backup of the changed website setup.
Monitor docs.to-increase.com analytics	Documentation	When published to docs.staedean.com, you can monitor the analytics of the documentation website. To analyze the website usage, we use Google analytics. For more information, refer to Google Analytics for docs.staedean.com. Note: As this link refers to a SharePoint file, you only can view the information with your name@staedean.com account active.
Monitor feedback	Documentation	When published to docs.staedean.com, you can monitor the feedback on D365 F&SCM documentation. The documentation for SATEDEAN products for D365 F&SCM has a feedback option. Monitor the feedback that is given by the users of docs.staedean.com/. The feedback is logged on this SharePoint site: STAEDEAN Documentation/TI-Product-Feedback. Log in with your name@staedean.com account. If you can't access it with this account, contact system admin to give you the rights for this SharePoint site.
Publish documentation to Word	Documentation	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.
Publish release notes website	Documentation	A specific sub-website is used to publish the release notes for the STAEDEAN products for D365 F&SCM: Release notes. The Release notes website has references to the release notes solutions and to the Life Sciences release notes website. Publish the release notes website to https://docs.staedean.com/. Screenshot of the release notes website overview: Screenshot of the release notes website tiles:
Publish reviewed project library to corporate library	Documentation	If the project library is reviewed, publish it. As a result, the project library is copied to the corporate libraries. Make sure, the project library stays as well!
Publish website to Azure storage explorer	Documentation	Use the Microsoft Azure Storage Explorer to copy the documentation website content files to the 'sadocswebsite' Azure storage account. This storage account is located in the To-Increase Production environment in Azure. Copy the website contents to this container: Blob Containers\$web. If you are: Updating the main website (docs.staedean.com), delete the 'Resources' folder and the 'index.html' file from the Blob Containers\$web container. Then copy the same folder and file from the unzipped website folder. Updating a full pillar website, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder. Updating the documentation for only one product, open the applicable pillar folder in the Blob Containers\$web, and delete the relevant product folder. The copy the new relevant product folder from the unzipped website folder. Adding the documentation for a new product, update the full related pillar website. To do so, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder. Updating the full release notes website, delete the 'Release notes' folder from the Blob Containers\$web container. Then copy the full new 'Release notes' folder from the unzipped website folder. Updating the release notes for only one pillar, open the 'Release notes' folder in the Blob Containers\$web, and delete the relevant pillar folder. The copy the new relevant pillar folder from the unzipped website folder. If you do not have access to this storage account, contact the system administrator. Picture of the Storage explorer showing the $web container contents:
Publish websites	Documentation	You can publish the STAEDEAN product documentation as a website. You can publish: The STAEDEAN Documentation main landing page: docs.steadean.com. Usually, you only do so if a pillar reference is added or removed. A full pillar documentation website. Usually, you do so if a new product tile is added to the pillar website setup. You can also do so if for several pillar products the documentation is updated. Then it's easier to just re-publish the whole pillar website. A product tile for a specific product. You can do this if for only one product the documentation is updated. As a result, the website (or tile) is published to a ZIP file.
Purge and refresh	Documentation	To properly update the documentation website, do these actions on Microsoft Azure, in the To-Increase Production environment: Purge cache and refresh the 'docsfrontdoor' endpoint. Refresh 'RG_DOCSWEBSITE' resource group. Refresh 'sadocswebsite' storage account.
Put flow elements in the right sequence	Documentation	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	Documentation	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'.
Receive and assess documentation feedback	Documentation	The services department can receive feedback on documentation. This can come from several sources. Sources are, for example: Customer Partner Internal (STAEDEAN service or support colleagues) Bug solution (Code changes to solve a bug can require a documentation change) The service department assesses the feedback, and if a documentation change is required, informs the technical writer.
Review created project library in LCS	Documentation	If you have exported business processes from RapidValue to LCS, a project library is created based on the: Business process hierarchy: for each business process, a process node is added to the library. Task guides as defined for the activities in the flows of the business processes: these task guides are added as the lowest process nodes to the business-process-related process nodes. Before you publish the created project library in LCS, review the created project library. Check at least if: For each business process, a process node is added with the related flow description. For each task guide a process node is added with the activity description. Each task guide is uploaded. If not, upload the task guide manually. If the task guide is not uploaded, the Diagram field is empty!
Set up video references	Documentation	You can use videos in documentation texts. To do so, first set up the video references.
Update release notes solutions	Documentation	Update the release notes solutions in RapidValue on the documentation VM. The current documentation VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/ For each pillar/area, a separate release notes solution exists: Release notes - Data Management - Doc Release notes - Equipment Rental -Doc Release notes - Manufacturing - Doc Release notes - Others - Doc Note: The Life Sciences release notes are published on a different platform/website. This is managed by the Life Sciences team. In each pillar release notes solution, for each product or product suite, a separate entry exists. Only list the five latest release notes. So, If you add a new release notes reference, and already five release notes are listed, remove the oldest release notes reference. The release notes reference has these parts: Protocol: The protocol always must be: https:// URL: Refers to the applicable release notes PDF file in the Azure Storage. The URL has two parts: [path to storage]/[document name incl. .pdf]. The 'path' to storage always is: docs.staedean.com/releasenotes/ Example: https://docs.staedean.com/releasenotes/Release Notes for RapidValue BPM Suite -10.0.29.38.pdf In Teams, in the STAEDEAN Documentation team, in files/STAEDEAN Docs Backup/Website backup, you can find a note pad file called ReleaseNotes-Hyperlinks.txt. You can use this file to quickly create the release note reference hyperlinks.
View solution references hierarchy	Documentation	You can view how a solution is related to other solutions. The solution relations are defined by the solution references. Each solution is shown as a building block in the solution references hierarchy. The current solution is highlighted. If you click the text in a building block, the Business process presentation viewer is opened for the solution. To show the solution references, this logic is applied (the texts between the brackets refer to the example picture): If the current solution: Has a reference solution defined, this reference solution is shown above of the current solution. (Solution1 has references: Solution2 and Solution 3) Is defined as reference solution of another solution, this other solution is shown below the current solution. (Solution1 is reference of: Solution 4 and Solution5) If a reference solution of the current solution also has a reference solution defined, this solution is shown above the reference solution. (Solution8 has reference: Solution2) If a reference solution of the current solution is also defined as a reference solution in another solution, the other solution is shown next to the current solution. (Solution5 has reference: Solution2) If a solution, that has the current solution as reference, is also defined as a reference in another solution, this other solution is shown below the solution. (Solution7 has references: Solution4 and Solution5)
Website setup	Documentation	Usually, you only change the website setup to add documentation for a new solution. This topic gives an explanation on how the STAEDEAN documentation website is set up. In RapidValue, this websites setup is used for the docs.staedean.com website: The main website: SATEDEAN Documentation (https://docs.staedean.com/). This website is the SATEDEAN product documentation landing page for the STAEDEAN solutions for D365 F&SCM. A sub-website for each of the pillars. Each pillar website is the landing page for the pillar documentation with references to the documentation of each pillar solution: Data Management (https://docs.staedean.com/data/) Equipment Rental (https://docs.staedean.com/rental/) Manufacturing (https://docs.staedean.com/manufacturing/) Other (https://docs.staedean.com/others/) Release notes (https://docs.staedean.com/Release notes/index.html) Note: The Life Sciences documentation is published on a different platform/website. This is managed by the Life Sciences team. The docs.staedean.com landing page has a reference to the Life Sciences documentation. Pictures of the STAEDEAN documentation websites setup Picture of the websites: Picture of the STAEDEAN Documentation website tiles: Picture of the Data Management website tiles: Picture of the Equipment Rental website tiles: Picture of the Manufacturing website tiles: Picture of the Others website tiles: Picture of the required Details setting for each tile:

Activities

Pictures of the STAEDEAN documentation websites setup