Documentation Index — Lofty Golden Oil ERP
Master index of all documentation. This file is updated as new documents are created. Last updated: July 2026
Overview Documents (00-overview)
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 01 | Executive Overview | Overview | High-level system overview, business context, architecture summary, cost benefits | Management, All Staff |
| 02 | System Architecture | Overview | Frontend, backend, database, infrastructure, deployment, and security architecture | Developers, DevOps, IT |
| 03 | Features Catalog | Overview | Complete feature listing by module with role access | All Staff |
| 04 | Glossary | Overview | All terms, abbreviations, and domain vocabulary | All Staff |
| 05 | Documentation Index | Overview | Master index of all documentation (this file) | All Staff |
User Guides
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 06 | Admin User Guide | User Guide | Complete guide for system administrators — user management, settings, audit log | Admin |
| 07 | Production User Guide | User Guide | Guide for production team — inventory management, production runs, BOM | Production Role |
| 08 | Sales User Guide | User Guide | Guide for sales team — customers, sales orders, invoicing, AR, receipts | Sales Role |
| 09 | Accountant User Guide | User Guide | Guide for accounting team — GL, journal entries, trial balance, P&L, bank reconciliation | Accountant Role |
| 10 | Dashboard & Reports Guide | User Guide | How to read and interpret dashboard KPIs, charts, and reports | All Staff |
| 11 | Requisitions User Guide | User Guide | How to create, approve, and track requisitions through the approval workflow | All Staff |
Operations & SOPs
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 12 | Inventory Management SOP | SOP | Standard operating procedures for stock management, adjustments, and audits | Production, Admin |
| 13 | Purchasing SOP | SOP | End-to-end purchasing workflow from requisition to receipt | Production, Admin |
| 14 | Production Run SOP | SOP | Creating and managing production runs, BOM, yield tracking | Production |
| 15 | Sales & Invoicing SOP | SOP | Sales order lifecycle from creation to payment receipt | Sales, Admin |
| 16 | Accounts Receivable SOP | SOP | Invoice generation, payment recording, aging, and collection | Sales, Accountant |
| 17 | Expense Management SOP | SOP | Expense recording, categorisation, and approval | Accountant, Admin |
| 18 | Requisition Approval SOP | SOP | 4-level approval workflow procedures | All Staff |
| 19 | Bank Reconciliation SOP | SOP | Monthly bank reconciliation procedures | Accountant |
| 20 | User Onboarding SOP | SOP | New user account setup, role assignment, training checklist | Admin |
Technical Documentation
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 21 | API Reference | Technical | Complete REST API endpoint documentation (routes, methods, request/response schemas) | Developers |
| 22 | Database Schema Reference | Technical | Complete database schema with table definitions, relationships, and indexes | Developers, DBA |
| 23 | Authentication & Authorisation | Technical | JWT authentication flow, RBAC implementation, security considerations | Developers, IT Security |
| 24 | Email Integration Guide | Technical | Resend API integration, email templates, trigger points | Developers, IT |
| 25 | Frontend Component Library | Technical | Shared component documentation (DataTable, SearchBar, Pagination, etc.) | Developers |
DevOps & Infrastructure
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 26 | Deployment Guide | DevOps | Step-by-step deployment procedures (staging and production) | DevOps, IT |
| 27 | CI/CD Pipeline Documentation | DevOps | GitHub Actions workflow configuration and troubleshooting | DevOps, Developers |
| 28 | Nginx Configuration Guide | DevOps | Reverse proxy setup, SSL, static file serving, SPA routing | DevOps, IT |
| 29 | PM2 Process Management Guide | DevOps | PM2 setup, monitoring, log management, clustering | DevOps, IT |
| 30 | Backup & Recovery Plan | DevOps | Database backup procedures, restoration, disaster recovery | DevOps, IT, Management |
Training Materials
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 31 | New Employee Training Manual | Training | Comprehensive onboarding training for all new ERP users | New Staff |
| 32 | Admin Training Manual | Training | In-depth admin training covering all administrative functions | Admin |
| 33 | Production Team Training | Training | Hands-on training for inventory and production modules | Production Role |
| 34 | Sales Team Training | Training | Hands-on training for customers, sales, and invoicing | Sales Role |
| 35 | Accountant Training | Training | Hands-on training for accounting, GL, and financial reporting | Accountant Role |
| 36 | Quick Reference Cards | Training | Laminated quick-reference cards for common tasks per role | All Staff |
Support & Maintenance
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 37 | Troubleshooting Guide | Support | Common issues and resolution steps for all modules | IT Help Desk, All Staff |
| 38 | FAQ Document | Support | Frequently asked questions from users | All Staff |
| 39 | Feature Request Process | Support | How to submit and track feature requests | All Staff |
| 40 | Change Log / Release Notes | Support | Version history, new features, bug fixes, breaking changes | Developers, IT, Admin |
Compliance & Security
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 41 | Security Policy | Compliance | System security policies, password requirements, access controls | All Staff, Management |
| 42 | Audit & Compliance Guide | Compliance | How to use audit log for regulatory compliance (NAFDAC, SON) | Admin, Accountant, Management |
| 43 | Data Privacy & Retention | Compliance | Data handling, privacy, and retention policies | Management, IT |
Developer Documentation
| Doc # | Title | Category | Description | Audience |
|---|---|---|---|---|
| 44 | Developer Setup Guide | Developer | Local development environment setup, dependencies, configuration | Developers |
| 45 | Codebase Architecture | Developer | Folder structure, naming conventions, coding standards | Developers |
| 46 | Contributing Guidelines | Developer | Pull request process, code review standards, branch strategy | Developers |
| 47 | Testing Guide | Developer | Testing approach, writing tests, running test suites | Developers |
| 48 | Environment Variables Reference | Developer | All environment variables and their purpose | Developers, DevOps |
Summary Statistics
| Category | Count |
|---|---|
| Overview Documents | 5 |
| User Guides | 6 |
| Operations & SOPs | 9 |
| Technical Documentation | 5 |
| DevOps & Infrastructure | 5 |
| Training Materials | 6 |
| Support & Maintenance | 4 |
| Compliance & Security | 3 |
| Developer Documentation | 5 |
| Total Planned Documents | 48 |
Document Maintenance
- Owner: Lofty Golden Oil IT Department
- Review Cycle: Quarterly
- Version Control: All documents tracked in Git repository
- Feedback: Submit via internal issue tracker or email
Document version: 1.0 — July 2026