Training Document Template¶

When to use this page¶

Copy and customise this template when you need to write structured training documentation for any SkyCMS audience (new editors, site builders, administrators). It covers learning outcomes, module-by-module instruction, exercises, troubleshooting, FAQ, keyboard shortcuts, and quick reference cards.

Document Information¶

Organization: [Your Organization Name]
Training Topic: [e.g., "SkyCMS Content Management"]
Created Date: [Date]
Version: 1.0
Author/Trainer: [Name]
Last Updated: [Date]
Audience: [Target audience, e.g., "New Content Editors", "Site Administrators"]

Document Overview¶

Purpose¶

This training document provides comprehensive instruction on [training topic]. Participants will learn the essential skills needed to [main objective], following a structured curriculum with hands-on practice.

Learning Outcomes: After completing this training, you will be able to: 1. [Outcome 1] 2. [Outcome 2] 3. [Outcome 3] 4. [Outcome 4]

Who Should Take This Training¶

[Audience 1, e.g., "New content editors"]
[Audience 2, e.g., "Site administrators"]
[Audience 3, e.g., "Marketing team members"]

Prerequisites: - [Prerequisite 1, e.g., "Basic computer skills"] - [Prerequisite 2, e.g., "Email and web browser knowledge"] - [Prerequisite 3, if applicable]

How to Use This Document¶

Reading Online: Use hyperlinks in the Table of Contents to jump to sections
Printing: Print entire document or specific sections as needed
Video Watching: Click video links throughout to watch instructional videos
Hands-On: Follow along with your own SkyCMS account to practice each skill
Reference: Bookmark this document for future reference

Table of Contents¶

1. Getting Started¶

System Requirements¶

Before starting, ensure you have: - ✅ A computer with internet access - ✅ Web browser (Chrome, Firefox, Safari, or Edge) - ✅ Login credentials for [system name] - ✅ [Any other requirement, e.g., "Email address"]

Video Tutorial: [Link to "First Login" video - 5 minutes]

Follow these steps:

Go to [website URL]
Click "Sign In" in the top right corner
Enter your email address: [your email]
Enter your password: [provided by administrator]
Click "Sign In"
You should see the main dashboard

If you forgot your password: Click "Forgot Password?" and follow the instructions sent to your email.

Dashboard Overview¶

When you first log in, you'll see the Dashboard with these main sections:

┌─────────────────────────────────────────────┐
│  Welcome, [Your Name]!                      │
├─────────────────────────────────────────────┤
│ Main Menu (Left Side)                       │
│ • Home                                      │
│ • Pages                                     │
│ • Templates                                 │
│ • Media/Files                               │
│ • Settings (Admin only)                     │
├─────────────────────────────────────────────┤
│ Quick Actions (Main Area)                   │
│ • Create New Page                           │
│ • View Recent Pages                         │
│ • Quick Links                               │
├─────────────────────────────────────────────┤
│ User Profile (Top Right)                    │
│ • My Account                                │
│ • Settings                                  │
│ • Logout                                    │
└─────────────────────────────────────────────┘

Module 1: System Overview¶

What is [System Name]?¶

[System name] is [brief description of what the system does]. It allows you to [main capabilities].

Key Features: - Feature 1: [Description] - Feature 2: [Description] - Feature 3: [Description] - Feature 4: [Description]

User Roles and Permissions¶

Different roles have different capabilities:

Role	Capabilities	Who Gets This
Viewer	View pages only (read-only)	[Who, e.g., "Stakeholders"]
Contributor	Create and edit their own content	[Who, e.g., "Content creators"]
Editor	Create, edit, approve all content	[Who, e.g., "Content managers"]
Administrator	All capabilities + system settings	[Who, e.g., "IT staff"]

Your Role: [Your specific role]

Main Menu (left side of screen): - Home: Dashboard and overview - Pages: Create, edit, view all pages - Templates: Manage page templates - Media: Upload and manage files/images - Settings: System settings (admin only) - Help: Documentation and support links - Logout: Sign out of the system

Top Navigation (right side of screen): - Profile icon: Access account settings - Search box: Search for pages or content - Notifications: System messages and alerts - Help icon: Quick help and documentation

Module 2: Core Features¶

Feature 1: [Feature Name]¶

Purpose: [What this feature does and why you'd use it]

How to Access: 1. Go to [menu location] 2. Click [button name] 3. Follow the prompts

Video Tutorial: [Link to video - X minutes]

Step-by-Step Guide¶

Step 1: [First major step] - [Sub-step 1] - [Sub-step 2] - [Sub-step 3]

Tips: - 💡 [Helpful tip] - 💡 [Helpful tip]

Step 2: [Second major step] - [Sub-step 1] - [Sub-step 2] - [Sub-step 3]

Common Mistakes: - ❌ Don't [mistake 1] - ❌ Don't [mistake 2] - ✅ Do [correct approach] instead

Example:

[Code example, screenshot, or formatted example]

Feature 2: [Feature Name]¶

Purpose: [What this feature does and why you'd use it]

When to Use: [Specific scenarios when you'd use this feature]

How to Access: 1. Go to [menu location] 2. Click [button name] 3. [Additional steps]

Video Tutorial: [Link to video - X minutes]

Key Concepts¶

Concept 1: [Explain key concept] - Related concept: [Explain relation] - Related concept: [Explain relation]

Concept 2: [Explain key concept] - Related concept: [Explain relation] - Related concept: [Explain relation]

Practice Exercise¶

Task: [Hands-on practice task]

What You Need: - [Resource 1] - [Resource 2] - [Resource 3]

Instructions: 1. [Step 1] 2. [Step 2] 3. [Step 3] 4. [Step 4] 5. [Step 5]

Expected Result: [What you should see when complete]

If You Get Stuck: See [troubleshooting section] for common issues.

Feature 3: [Feature Name]¶

[Follow same structure as Feature 1 and 2]

Module 3: Common Tasks¶

Task 1: [Common Task Name]¶

Time Required: [X] minutes
Difficulty: Beginner / Intermediate / Advanced
Video Guide: [Link - X minutes]

Objective: [What you're trying to accomplish]

Prerequisites: - [ ] [Prerequisite 1] - [ ] [Prerequisite 2] - [ ] [Prerequisite 3]

Step-by-Step Instructions:

[First major step]
Click [button/menu]
Enter [information]
Click [button]
You should see [result]
[Second major step]
Look for [element]
[Action description]
Verify [confirmation]
[Third major step]
Select [option]
[Action description]
Wait for [confirmation message]
[Final step]
Review [what to check]
Click [button]
Task complete! You should see [final result]

Tips for Success: - 💡 [Useful tip] - 💡 [Useful tip] - 💡 [Useful tip]

Common Issues: - Issue: [Problem] - Solution: [How to fix] - Issue: [Problem] - Solution: [How to fix]

Quick Checklist: - [ ] Step 1 completed - [ ] Step 2 completed - [ ] Step 3 completed - [ ] Step 4 completed - [ ] Final result verified

Task 2: [Common Task Name]¶

[Follow same format as Task 1]

Task 3: [Common Task Name]¶

[Follow same format as Task 1]

Module 4: Advanced Topics¶

Advanced Topic 1: [Topic Name]¶

Level: Advanced (recommended after completing core modules)

Prerequisites: - Solid understanding of [core feature] - Ability to perform [common task]

Video Guide: [Link - X minutes]

Overview: [Explain what this advanced topic covers and why it's useful]

Detailed Explanation¶

[Detailed content about this advanced topic, with examples and use cases]

Best Practices¶

When working with [topic], follow these best practices:

Best Practice 1: [Description and rationale]
Example: [Specific example]
Avoid: [What not to do]
Best Practice 2: [Description and rationale]
Example: [Specific example]
Avoid: [What not to do]
Best Practice 3: [Description and rationale]
Example: [Specific example]
Avoid: [What not to do]

Advanced Exercise¶

Challenge: [Advanced hands-on task]

Resources Needed: - [Resource 1] - [Resource 2]

Instructions: 1. [Step 1 - more complex than basic tasks] 2. [Step 2] 3. [Step 3] 4. [Step 4]

Success Criteria: [How to know you completed it correctly]

Extension: [Optional additional challenge for advanced learners]

Advanced Topic 2: [Topic Name]¶

[Follow same format as Advanced Topic 1]

Troubleshooting Guide¶

Common Issues and Solutions¶

Issue 1: [Common Problem]¶

Symptoms: - [Sign 1] - [Sign 2] - [Sign 3]

Possible Causes: 1. [Cause 1] 2. [Cause 2] 3. [Cause 3]

Solutions (try in order):

Solution 1: [First thing to try] - Steps: 1. [Step 1] 2. [Step 2] 3. [Step 3] - If this works: Great! You're done. - If not: Try Solution 2.

Solution 2: [Second thing to try] - Steps: 1. [Step 1] 2. [Step 2] 3. [Step 3] - If this works: Great! You're done. - If not: Try Solution 3.

Solution 3: [Last resort/nuclear option] - Steps: 1. [Step 1] 2. [Step 2] 3. [Step 3] - If still not working: Contact support

Prevention: To avoid this issue in the future: - [Prevention tip 1] - [Prevention tip 2]

Issue 2: [Common Problem]¶

[Follow same structure as Issue 1]

Issue 3: [Common Problem]¶

[Follow same structure as Issue 1]

Error Messages Reference¶

Error Message	Meaning	Solution
"[Error message text]"	[What it means]	[How to fix it]
"[Error message text]"	[What it means]	[How to fix it]
"[Error message text]"	[What it means]	[How to fix it]

Frequently Asked Questions¶

General Questions¶

Q: [Common question]
A: [Detailed answer to question]

Feature-Specific Questions¶

Q: Can I [specific action]?
A: Yes, [explanation]. Here's how: 1. [Step 1] 2. [Step 2] 3. [Step 3]

Q: What's the difference between [concept A] and [concept B]?
A: [Explanation of difference] - Concept A is used for [use case] - Concept B is used for [use case]

Q: Is there a limit to [something]?
A: [Answer about limit]

Account & Permissions¶

Q: How do I reset my password?
A: 1. Click "Forgot Password" on the login page 2. Enter your email address 3. Check your email for password reset link 4. Click the link and enter your new password 5. Sign in with your new password

Q: Who can see my content?
A: [Explanation of permissions]

Q: How do I request access to something I can't see?
A: Contact [name/role] at [email] with your request

Best Practices Questions¶

Q: What's the best practice for [common task]?
A: [Recommended approach and why]

Q: How often should I [maintenance task]?
A: [Recommended frequency and why]

Keyboard Shortcuts¶

Speed up your work with these keyboard shortcuts:

Action	Windows	Mac
Save	Ctrl + S	Cmd + S
Find/Search	Ctrl + F	Cmd + F
Select All	Ctrl + A	Cmd + A
Copy	Ctrl + C	Cmd + C
Paste	Ctrl + V	Cmd + V
Undo	Ctrl + Z	Cmd + Z
Redo	Ctrl + Y	Cmd + Shift + Z

Additional Resources¶

Video Library¶

Title	Link	Duration	Topic
[Video 1: Getting Started]	[Link]	5 min	Introduction
[Video 2: Creating Your First Page]	[Link]	8 min	Core task
[Video 3: Advanced Features]	[Link]	12 min	Advanced

Documentation¶

External Resources¶

Getting Help¶

Stuck? Here's how to get help:

First: Check Troubleshooting Guide above
Second: Search FAQ for your question
Third: Watch relevant Video
Still stuck: Contact [support team]

Contact Information: - Email Support: [email] - Phone Support: [phone number] - Slack Channel: [channel name] - Hours: [Support hours] - Response Time: [Typical response time]

For Bugs/Issues: - Report to: [email or system] - Include: [What information to provide]

Feedback¶

We'd love to hear from you!

Was this training helpful? [Link to feedback form]

Suggestions for improvement? Email us at [email]

Topics you'd like to learn about? Let us know at [email]

Version History¶

Version	Date	Changes	Author
1.0	[Date]	Initial training document	[Name]

Quick Reference Card¶

Print this page and keep it at your desk for quick reference:

Most Used Keyboard Shortcuts¶

Save: Ctrl+S (Cmd+S Mac)
Search: Ctrl+F (Cmd+F Mac)
Undo: Ctrl+Z (Cmd+Z Mac)
Help: F1 or ? (help button)

Emergency Contacts¶

Technical Support: [Email]
Questions: [Email]
Emergency: [Phone]

Links¶

Main Site: [URL]
Documentation: [URL]
Support: [URL]

Document Metadata¶

Last Updated: [Date]
Next Review: [Date]
Owner: [Name/Department]
Status: [Draft/Published/Under Review]

How to Use This Template¶

Replace all bracketed sections [like this] with your actual content
Remove example sections after filling in real information
Update module numbers to match your training structure
Add or remove modules as needed for your topic
Include actual video links to your training videos
Test all links before distributing
Share with training participants and gather feedback
Update periodically (at least annually) to keep current

Tips: - Keep language simple and clear - Use bullet points and short sentences - Include plenty of examples and exercises - Test instructions before publishing - Encourage hands-on practice - Provide multiple ways to learn (video, text, practice)