This video explains the guidelines for structuring systems documentation.
Systems Documentation Layout guidelines
-
Organize content using headings and paragraphs.
-
Use bold formatting to highlight important sections.
-
Add external links as needed.
-
Link internal systemHUB systems, particularly if there's an existing system for a specific step
-
Break down processes into steps.
-
Add screenshots for visual aid and clarity but avoid excessive use due to potential software changes.
-
Add videos to enable a visual walkthrough of tasks.