The Syntasa application offers a robust feature for adding notes and comments, enhancing team collaboration and communication. This feature is available for both Development and Production workflows, ensuring that important information is documented and accessible throughout the app lifecycle.
The application offers two types of notes:
- App Notes: These are general-purpose notes that are not tied to any specific process.
- Process Notes: These notes allow you to add comments for each process type available on the workflow canvas.
Note: Notes are specific to each workflow, such as Development and Production. After deployment, notes are not transferred from the Development workflow to the Production workflow.
App Notes
App notes are general comments or documentation related to the workflow. They are not tied to any specific process within the app. These notes can be used to document the overall objectives of the app, major changes, user instructions, or any high-level information relevant to the app as a whole.
You can access App notes from the workflow screen. To do so, click on the top icon () located on the right-side panel of the Workflow screen. This will open the Notes panel.
Process Notes
These Process notes are specific to each process available on the workflow canvas, such as Transform, Lookahead, Spark Processor, etc. These notes can include detailed descriptions of what each process does, configuration details, troubleshooting tips, and any changes made over time.
Common features
The notes panel in Syntasa offers several versatile features designed to enhance the usability and functionality of both App Notes and Process Notes. These features facilitate efficient management of notes within the platform. Below is a detailed explanation of these common features:
- Search: Users can easily search through notes by typing relevant text into the search bar, displaying all matching notes. This feature allows for quick retrieval of specific notes, saving time and improving efficiency, especially in apps with many notes.
- Notes Count: The notes panel displays the total count of App Notes and Process Notes on their respective tabs, with counts visible for each process. This helps to easily monitor the volume of documentation at both the app and process levels.
- Filtering & Sorting: Notes can be filtered and sorted based on various criteria such as name, creation time, and updated time. This functionality allows users to organize notes efficiently, making it easier to locate specific information when needed.
- Replying to Note: Users can reply to notes, creating a conversational thread. This enhances collaboration by enabling discussions directly within the note.
- Editing the Comment: The user who added a comment can edit it anytime, with the edited timestamp visible.
- Deleting the Comment: Notes or replies can be deleted by the user who owns them.