Workflow comments and notes
Is there any way to create and display comments or notes within a workflow? An example might be some notes that describe, in more detail than the workflow name, what the purpose of the workflow is and the process that is being followed to produce the output.
Best Answer
-
Clinton Jones
Experian Elite
In releases up to v1.5 it is not possible to insert inline notes or document your workflow. Your only options for documenting your workflow is to rename the step. In your workflow design you should also consider breaking a large transform step into logical discrete transform steps, while this may result in workflow sprawl it is a balance between making your workflow understandable, compartmentalised and readable vs simply functional. From a product management stand-point, we understand this limitation in documenting your solutions today. Expect to see the ability to annotate workflows in a later release.
6
Answers
Thanks Clinton. I agree that smaller and more visible steps and functions does make a workflow easier to read and understand, and that's also precisely why annotation is needed. I look forward to seeing this in a forthcoming release.
Agree - it would be great to add a 'post-it' type comment to a workflow to give it a bit of context and history. Would make traceability easier to manage. Thanks.
As Aperture becomes more powerful and is used for 'black box' UAT production processes the need for annotation becomes increasingly important for support and maintenance purposes so great to see this improved functionality is coming.