Portal Community
BizFirstAI Portal / Error Management / Documentation

Step 2: Error Documentation

Create comprehensive error reference pages.

What it covers: How to create detailed error documentation pages that developers and AI agents can use to troubleshoot issues.

Error Page Template

Each error code gets a dedicated HTML page that documents:

Naming Convention

Error documentation pages follow this naming pattern:

Error-{PRODUCT}-{NUMBER}.html

Examples:
Error-FlowStudio-100090.html
Error-AppStudio-200001.html

HTML Template

Copy the following template and customize the content sections:

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1">
<title>Error-PRODUCT-NUMBER | Error Management — BizFirstAI</title>
<link rel="stylesheet" href="../styles.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
<style>
.bfai-topbar-logo img{height:26px;display:block;}.bfai-topbar{position:fixed;top:0;left:0;right:0;z-index:200;background:#1e2736;border-bottom:1px solid #2d3a4a;height:40px;display:flex;align-items:center;padding:0 20px;}
.bfai-topbar-right{margin-left:auto;display:flex;gap:6px;}
.bfai-topbar-right a{font-size:12px;color:#b0c4d8;text-decoration:none;padding:4px 12px;border-radius:5px;display:flex;align-items:center;gap:6px;transition:background 0.15s,color 0.15s;}
.bfai-topbar-right a:hover{background:rgba(255,255,255,0.08);color:#fff;}
body{padding-top:40px;}
nav.sidebar{top:40px;height:calc(100vh - 40px);}
</style>
</head>
<body>

<div class="bfai-topbar">
  <a href="https://bizfirstai.com" target="_blank" class="bfai-topbar-logo">
    <img src="https://www.bizfirstai.com/website/assets/Logo/logo.png" alt="BizFirstAI">
  </a>
  <div class="bfai-topbar-right">
    <a href="https://bizfirstai.github.io/UserGuides/" target="_top"><i class="fa-solid fa-house"></i> Portal</a>
    <a href="https://community.bizfirstai.com" target="_blank"><i class="fa-solid fa-people-group"></i> Community</a>
  </div>
</div>

<nav class="sidebar">
  <div class="sidebar-brand">Error Codes<span>Reference</span></div>
  <div class="sidebar-section">Troubleshooting</div>
  <a href="Index.html">Error Index</a>
  <a href="Error-PRODUCT-NUMBER.html" class="active">Error-PRODUCT-NUMBER</a>
  <div class="sidebar-section">Navigation</div>
  <a href="../">← Error Management</a>
  <a href="../../">← Portal</a>
</nav>

<main>
  <div class="page-header">
    <div class="breadcrumb">
      <a href="../../" style="color:inherit;text-decoration:none;">BizFirstAI Portal</a> /
      <a href="../" style="color:inherit;text-decoration:none;">Error Management</a> /
      Error Codes
    </div>
    <h1>Error-PRODUCT-NUMBER</h1>
    <p class="subtitle">One-line error description</p>
  </div>

  <div class="callout warning">
    <strong>Error Message:</strong> <code>Copy the actual error message here</code>
  </div>

  <h2>What It Means</h2>
  <p>Clear explanation of what happened and why the error was raised.</p>

  <h2>Common Causes</h2>
  <ul>
    <li>First common cause</li>
    <li>Second common cause</li>
    <li>Third common cause</li>
  </ul>

  <h2>How to Fix</h2>
  <ol>
    <li>First troubleshooting step</li>
    <li>Second troubleshooting step</li>
    <li>Third troubleshooting step</li>
  </ol>

  <h2>Examples</h2>
  <h3>Example 1: Scenario Description</h3>
  <pre><code>Code example or configuration that triggers the error</code></pre>

  <h2>Prevention</h2>
  <p>Best practices to avoid this error in the future.</p>

  <h2>Related Errors</h2>
  <ul>
    <li><a href="Error-PRODUCT-100001.html">Error-PRODUCT-100001</a></li>
    <li><a href="Error-PRODUCT-100002.html">Error-PRODUCT-100002</a></li>
  </ul>

  <h2>Need Help?</h2>
  <div class="callout info">
    <p>If this guide didn't help, visit the <a href="https://community.bizfirstai.com" target="_blank">BizFirst Community</a> or open an issue on GitHub.</p>
  </div>

</main>
</body>
</html>

Content Guidelines

What It Means

Explain the error in plain language, not technical jargon:

Common Causes

List the most likely reasons the error occurs, in order of frequency:

How to Fix

Provide step-by-step troubleshooting instructions:

  1. Check: What to verify or inspect
  2. Try: A specific action or change
  3. Verify: How to confirm the fix worked

Examples

Include realistic examples that show:

Prevention

Help developers avoid this error:

Writing Style

✓ Do:
❌ Avoid:

File Placement

UserGuides/docs/WebSites/ErrorManagement/ErrorCodes/
├── Index.html                         ← Error code index
├── Error-FlowStudio-100090.html       ← Individual error pages
├── Error-FlowStudio-100091.html
├── Error-AppStudio-200001.html
└── ... more error codes ...

Validation Checklist

Next Steps

Once your error documentation is complete, proceed to Step 3: Publishing to make it publicly available.