Skip to main content

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 #TitleCategoryDescriptionAudience
01Executive OverviewOverviewHigh-level system overview, business context, architecture summary, cost benefitsManagement, All Staff
02System ArchitectureOverviewFrontend, backend, database, infrastructure, deployment, and security architectureDevelopers, DevOps, IT
03Features CatalogOverviewComplete feature listing by module with role accessAll Staff
04GlossaryOverviewAll terms, abbreviations, and domain vocabularyAll Staff
05Documentation IndexOverviewMaster index of all documentation (this file)All Staff

User Guides

Doc #TitleCategoryDescriptionAudience
06Admin User GuideUser GuideComplete guide for system administrators — user management, settings, audit logAdmin
07Production User GuideUser GuideGuide for production team — inventory management, production runs, BOMProduction Role
08Sales User GuideUser GuideGuide for sales team — customers, sales orders, invoicing, AR, receiptsSales Role
09Accountant User GuideUser GuideGuide for accounting team — GL, journal entries, trial balance, P&L, bank reconciliationAccountant Role
10Dashboard & Reports GuideUser GuideHow to read and interpret dashboard KPIs, charts, and reportsAll Staff
11Requisitions User GuideUser GuideHow to create, approve, and track requisitions through the approval workflowAll Staff

Operations & SOPs

Doc #TitleCategoryDescriptionAudience
12Inventory Management SOPSOPStandard operating procedures for stock management, adjustments, and auditsProduction, Admin
13Purchasing SOPSOPEnd-to-end purchasing workflow from requisition to receiptProduction, Admin
14Production Run SOPSOPCreating and managing production runs, BOM, yield trackingProduction
15Sales & Invoicing SOPSOPSales order lifecycle from creation to payment receiptSales, Admin
16Accounts Receivable SOPSOPInvoice generation, payment recording, aging, and collectionSales, Accountant
17Expense Management SOPSOPExpense recording, categorisation, and approvalAccountant, Admin
18Requisition Approval SOPSOP4-level approval workflow proceduresAll Staff
19Bank Reconciliation SOPSOPMonthly bank reconciliation proceduresAccountant
20User Onboarding SOPSOPNew user account setup, role assignment, training checklistAdmin

Technical Documentation

Doc #TitleCategoryDescriptionAudience
21API ReferenceTechnicalComplete REST API endpoint documentation (routes, methods, request/response schemas)Developers
22Database Schema ReferenceTechnicalComplete database schema with table definitions, relationships, and indexesDevelopers, DBA
23Authentication & AuthorisationTechnicalJWT authentication flow, RBAC implementation, security considerationsDevelopers, IT Security
24Email Integration GuideTechnicalResend API integration, email templates, trigger pointsDevelopers, IT
25Frontend Component LibraryTechnicalShared component documentation (DataTable, SearchBar, Pagination, etc.)Developers

DevOps & Infrastructure

Doc #TitleCategoryDescriptionAudience
26Deployment GuideDevOpsStep-by-step deployment procedures (staging and production)DevOps, IT
27CI/CD Pipeline DocumentationDevOpsGitHub Actions workflow configuration and troubleshootingDevOps, Developers
28Nginx Configuration GuideDevOpsReverse proxy setup, SSL, static file serving, SPA routingDevOps, IT
29PM2 Process Management GuideDevOpsPM2 setup, monitoring, log management, clusteringDevOps, IT
30Backup & Recovery PlanDevOpsDatabase backup procedures, restoration, disaster recoveryDevOps, IT, Management

Training Materials

Doc #TitleCategoryDescriptionAudience
31New Employee Training ManualTrainingComprehensive onboarding training for all new ERP usersNew Staff
32Admin Training ManualTrainingIn-depth admin training covering all administrative functionsAdmin
33Production Team TrainingTrainingHands-on training for inventory and production modulesProduction Role
34Sales Team TrainingTrainingHands-on training for customers, sales, and invoicingSales Role
35Accountant TrainingTrainingHands-on training for accounting, GL, and financial reportingAccountant Role
36Quick Reference CardsTrainingLaminated quick-reference cards for common tasks per roleAll Staff

Support & Maintenance

Doc #TitleCategoryDescriptionAudience
37Troubleshooting GuideSupportCommon issues and resolution steps for all modulesIT Help Desk, All Staff
38FAQ DocumentSupportFrequently asked questions from usersAll Staff
39Feature Request ProcessSupportHow to submit and track feature requestsAll Staff
40Change Log / Release NotesSupportVersion history, new features, bug fixes, breaking changesDevelopers, IT, Admin

Compliance & Security

Doc #TitleCategoryDescriptionAudience
41Security PolicyComplianceSystem security policies, password requirements, access controlsAll Staff, Management
42Audit & Compliance GuideComplianceHow to use audit log for regulatory compliance (NAFDAC, SON)Admin, Accountant, Management
43Data Privacy & RetentionComplianceData handling, privacy, and retention policiesManagement, IT

Developer Documentation

Doc #TitleCategoryDescriptionAudience
44Developer Setup GuideDeveloperLocal development environment setup, dependencies, configurationDevelopers
45Codebase ArchitectureDeveloperFolder structure, naming conventions, coding standardsDevelopers
46Contributing GuidelinesDeveloperPull request process, code review standards, branch strategyDevelopers
47Testing GuideDeveloperTesting approach, writing tests, running test suitesDevelopers
48Environment Variables ReferenceDeveloperAll environment variables and their purposeDevelopers, DevOps

Summary Statistics

CategoryCount
Overview Documents5
User Guides6
Operations & SOPs9
Technical Documentation5
DevOps & Infrastructure5
Training Materials6
Support & Maintenance4
Compliance & Security3
Developer Documentation5
Total Planned Documents48

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