How-To Knowledge Article Template for TeamDynamix

Use this template to create structured, step-by-step guides that help users complete specific tasks or processes. Find guidance and style recommendations here.

Be Aware of Guidelines

Read the TeamDynamix Content Style Guide for full guidelines on writing knowledge articles. Reminder, each article needs a properly formatted title, summary, and tags.

About This Template
This template is designed to provide step-by-step instructions to help users complete a specific task or process.

When to Use This Template
Use this template when:

• When explaining how to use a feature or tool.
• When guiding users through a setup or installation process.
• When demonstrating how to perform a specific action within a software application.

Example Use Case for this Template
An article about setting up multi-factor authentication.

Best Practices for Writing How-To Articles

• Provide clear, step-by-step guidance.
  • Use numbered steps when order matters.
  • Use bullet points for unordered steps.
• Provide Context: Explain any prerequisites or tools needed before starting. If there are different steps depending on the device or operating system, note that.
• Minimize the use of screenshots whenever possible.
  • Instead, provide clear, written instructions to ensure accessibility and longevity.
  • If images are necessary, ensure all include alt text for accessibility and all important information is also clearly included in text on the page.
  • Read more about accessibility

 

⚠️ REMOVE ALL TEMPLATE INSTRUCTIONS BEFORE FINALIZING THE ARTICLE.

A short paragraph or two describing what the user will find in this article, how it can help them, who it is for, etc. 

This section is optional, use only if the environment matters. Choose either State-Owned Devices or Personal Devices and delete the other. If environment doesn't matter, delete this whole section.

State-Owned Devices: Equipment provided to university employees and managed by Minnesota State University, Mankato. The steps, tools, or solutions in this article may not work on personal devices due to administrative restrictions or licensing requirements. 

Personal Devices: Equipment owned and maintained by individual users. 

A description of the task that your users are looking to accomplish.

1. First step
2. Second step
3. Third step

Outcome

• Link to external resources if applicable

Visit the IT Solutions Center page to view current hours, locations, and contact information.