Great digital content should be clear, helpful, consistent, and easy to follow. AcceleratorKMS makes it easier to build and deliver content that improves the overall user experience. Whether you're a content strategist, writer, or solution engineer, here are some simple best practices to keep in mind when designing and developing procedural content.
Define one action per step
If a step involves more than one action, break it into separate steps—unless the actions happen at the same time. In that case, you can keep them together in one statement.
Example:
-
ü PLACE x in AUTOMATIC AND SET to 80 (if done together)
-
û PLACE x and SET to 80 (if done separately)
Define one task per procedure
If a procedure includes several unrelated tasks, split them into separate procedures—one for each task.
Example:
-
Pump startup
-
Pump shutdown
If a procedure includes tasks that depend on each other, break the procedure into separate tasks and connect them in the right order using a clear flow.
Example – System Startup Flow may contain the following individual tasks:
-
Cooling fan startup
-
Pump startup
-
Heater startup
Limit the number of statements in a document
To keep your content fast and responsive, follow these guidelines:
-
Recommended: Keep the number of statements to 250 or less.
-
Performance impact: Documents with 500 or more statements may take 15 seconds or more to load, and can slow down other documents loading at the same time.
-
Maximum limit: The content limit is 1,000 statements.