iSuTech Knowledge Hub - User Guide

iSuTech Knowledge Hub - User Guide

For Team Members

---

🎯 Welcome to the Knowledge Hub!

The iSuTech Knowledge Hub is your central resource for all company documentation, templates, and knowledge. This guide will help you get started quickly.

What you’ll find here:

• Email templates for client outreach
• Business development resources
• Project templates and guides
• Operations procedures
• Knowledge base with case studies
• Best practices and lessons learned

---

🔐 Accessing the Documentation

Step 1: Visit the Site

URL: https://docs.isutech.co.za

Step 2: Login

When you visit the site, you’ll see a login prompt:

• Username: isutech
• Password: [Ask your team lead or check password manager]

Security Notes:

• Don’t share the password via email or Slack
• Close your browser when done or leaving your desk
• Lock your computer when stepping away

Step 3: Browse & Search

Once logged in, you have full access to all documentation!

---

🔍 Finding What You Need

Method 1: Search (Fastest!)

1. Click the search box (top-right corner)
2. Type keywords (e.g., “email template”, “proposal”, “project charter”)
3. Press Enter or click a suggestion
4. Results appear instantly with highlighted keywords

Search Tips:

• Be specific: “government email template” vs just “template”
• Try different words: “BD” vs “business development”
• Use quotes for exact phrases: “post presentation followup”

Method 2: Navigation Tabs

Top navigation tabs:

• Home - Main page with quick links
• Marketing - Email templates, campaign guides
• Business Development - Proposals, business cases
• Projects - Project charters, templates
• Operations - Processes, procedures
• Knowledge Base - Case studies, lessons learned
• Templates - Complete template library

Click any tab to browse that section.

Method 3: Sidebar Navigation

• Left sidebar shows page structure
• Right sidebar (table of contents) shows headings on current page
• Click any heading to jump to that section

---

📋 Common Tasks

Task 1: Send Email to Potential Client

Steps:

1. Go to Marketing tab
2. Click Email Templates
3. Select category:
   • Client Prospecting for new leads
   • Follow-ups for post-demo emails
   • Partnerships for strategic partners
4. Open relevant template
5. Copy the content
6. Customize with client details
7. Send!

Pro Tip: Check Example Customized Emails to see real-world examples.

---

Task 2: Write a Proposal

Steps:

1. Go to Templates tab
2. Click Business Development
3. Open Proposal Template
4. Download/copy the template
5. Fill in your project details
6. Use standard metrics:
   • ML Accuracy: 78%
   • ROI: 134% within 18 months
   • Time Savings: 40%

Reference: Proposal Template

---

Task 3: Start a New Project

Steps:

1. Go to Templates tab
2. Click Projects
3. Open Project Charter Template
4. Copy the structure
5. Fill in project details
6. Share with team

Reference: Project Charter Template

---

Task 4: Find Company Metrics

Quick Reference:

Metric	Value	Use For
ML Accuracy	78%	Technical proposals
ROI	134% in 18 months	Business cases
Time Savings	40%	Efficiency claims
Automation Rate	80%+	Process improvement

Source: Based on MGSLG and SACE case studies

---

💡 Using Templates Effectively

Best Practices

✅ Do:

• Always start with a template - don’t reinvent the wheel
• Read examples first - see what “good” looks like
• Customize thoroughly - make it specific to your client
• Update metadata - fill in the document header
• Check links - ensure all references work

❌ Don’t:

• Start from blank document
• Copy-paste without customization
• Use outdated metrics or data
• Skip proofreading

Template Customization Checklist

When using any template:

• Replace [PLACEHOLDER TEXT] with real information
• Update dates to current
• Customize to client’s specific needs
• Add relevant examples or case studies
• Update contact information
• Proofread for errors
• Review with team lead (for major docs)

---

🎨 Reading Documents

Document Structure

Most documents follow this format:

# Main Title

Brief introduction

## Section 1
Content...

## Section 2
Content...

## Related Documents
Links to related resources

Navigation Features

Dark/Light Mode Toggle:

• Click sun/moon icon (top-right)
• Choose your preference
• Setting remembers between visits

Back to Top:

• Scroll down on any page
• Click ↑ button (bottom-right)
• Jumps back to top

Edit This Page:

• Click pencil icon (top-right of content)
• Takes you to GitHub to suggest edits
• Requires GitHub account

---

📱 Mobile Access

The documentation works great on mobile devices!

Mobile Features:

• Hamburger menu (☰) for navigation
• Optimized reading experience
• Search works the same way
• All content accessible

Tip: Save the site to your phone’s home screen for quick access!

---

🆘 Getting Help

Can’t Find What You Need?

1. Try search - use different keywords
2. Browse categories - check all navigation tabs
3. Ask your team - someone may know where it is
4. Contact document owner - listed in document metadata
5. Request new documentation - email [Technical Lead]

Found an Error or Outdated Info?

Option 1: Quick Fix

• Click “Edit this page” icon
• Make changes on GitHub
• Submit change

Option 2: Report It

• Note the document name and issue
• Contact the document owner (in metadata)
• Or create GitHub issue

Technical Issues

Site not loading:

• Check your internet connection
• Try incognito/private mode
• Clear browser cache
• Contact [Technical Lead]

Login not working:

• Verify username: isutech
• Check password with team lead
• Try different browser

---

🌟 Pro Tips

Keyboard Shortcuts

• / or S - Focus search box
• F or Ctrl+F - Find text on page
• Esc - Close search

Bookmarking

Save frequently used pages:

1. Navigate to the page
2. Bookmark it (Ctrl+D / Cmd+D)
3. Create “iSuTech Docs” folder
4. Quick access anytime!

Suggested bookmarks:

• Homepage (quick links)
• Email templates index
• Your department’s section
• Template library

Staying Updated

The docs are always current!

• Updated automatically every 10 minutes from Git
• Fresh content without manual refresh
• When you push to GitHub, live in 10 minutes

No app to install, no software to update - just use your browser!

---

📊 Understanding Document Metadata

Every document has a header like this:

---
title: Document Title
description: What this covers
author: Creator Name
created: 08/11/2025
updated: 08/11/2025
version: 1.0
category: marketing
status: approved
owner: Marketing Lead
---

Key fields:

• Title - Document name
• Owner - Who to contact about this doc
• Updated - Last revision date
• Status - draft, review, or approved
• Version - 1.0, 1.1, 2.0, etc.

Use this to:

• Verify document is current
• Know who to ask questions
• Check if approved for external use

---

✅ Quick Start Checklist

New to the Knowledge Hub? Complete these steps:

• Access https://docs.isutech.co.za and login
• Try the search - search for your role or project
• Browse your department’s section
• Bookmark frequently used templates
• Read at least one example document
• Try customizing a template
• Set up dark/light mode preference
• Bookmark the homepage

Time needed: ~20 minutes

---

🎯 Department-Specific Quick Links

Marketing Team

• Email Templates
• Campaign Tracking
• Quick Start Guide

Business Development

• Proposal Template
• Business Case Template
• Opportunity Assessment

Project Management

• Project Charter
• Project Documentation

All Departments

• Document Standards
• Template Library

---

🎉 You’re Ready!

You now know how to:

• ✅ Access and login to the Knowledge Hub
• ✅ Search for content effectively
• ✅ Navigate using tabs and sidebar
• ✅ Use templates properly
• ✅ Find help when needed

Welcome to more efficient, organized documentation!

---

📞 Contact & Support

Questions about:

• Site access → [Technical Lead]
• Marketing docs → [Marketing Lead]
• BD docs → [BD Lead]
• Templates → Document owner (in metadata)
• Technical issues → [Technical Lead]

Found this guide helpful? Share it with new team members!

---

iSuTech Knowledge Hub User Guide Last Updated: 09/11/2025 Questions? Ask your team lead or check Getting Started