DocuLog

Engineering Logbook for Professional Practice, PE Registration, and CPD Tracking

npnpm | docs

DocuLog is an engineering logbook system built on the DocuMint framework, designed for engineers who need to maintain daily logbook entries with professional attestation and counter-signature workflows.

Features

• Daily Logbook Entries: Time-ordered entries organized by date
• Counter-Signature Chain: Supervisor review and approval workflow
• PE Attestation: Professional Engineer registration support
• CPD Tracking: Automatic Continuing Professional Development summary
• Professional Seals: PE seal application with content integrity verification
• Export for Submission: Export entries as PDF or JSON for PE applications

Workflow

Entry Created (draft)
    ↓
Submitted for Review
    ↓
Counter-Signed by Supervisor
    ↓
Approved by PE (if required)
    ↓
Sealed (optional professional seal)
    ↓
Archived (part of permanent record)

Installation

cd doculog
npm install

Quick Start

Initialize Logbook

doculog init --name "Jane Engineer" --email "[email protected]" --role "Junior Engineer"

Create Daily Entry

doculog entry new --date 2024-04-28 --project "Bridge Design" --discipline "Civil"

Submit for Review

doculog entry submit entry-20240428-001 --user "Jane Engineer" --note "Ready for review"

Counter-Signature

doculog attest sign entry-20240428-001 --user "Dr. Supervisor" --comments "Calculations verified"

PE Approval

doculog attest approve entry-20240428-001 --user "Dr. PE" --license "PE-12345" --seal

CPD Summary

doculog cpd --from 2024-01-01 --to 2024-04-28 --summary

Entry Data Model

{
  id: "entry-20240428-001",
  date: "2024-04-28",
  engineer: {
    name: "Jane Engineer",
    email: "[email protected]",
    licenseNumber: null,
    role: "Junior Engineer"
  },
  supervisor: {
    name: "Dr. Smith",
    licenseNumber: "PE-12345",
    role: "Senior Engineer / PE"
  },
  content: {
    summary: "Calculated stress loads for support structure...",
    details: "...",
    calculations: "...",
    drawings: [],
    references: [],
    project: "Bridge Design",
    discipline: "Civil"
  },
  attestations: [
    {
      type: "counter-signature",
      by: "Dr. Smith",
      date: "2024-04-29",
      comments: "Verified calculations"
    }
  ],
  status: "counter-signed",
  seal: null
}

Commands

| Command | Description | |---------|-------------| | doculog init | Initialize logbook | | doculog entry new | Create new daily entry | | doculog entry list | List entries by date range | | doculog entry view | View entry details | | doculog entry edit | Edit draft entry | | doculog entry submit | Submit entry for review | | doculog attest sign | Counter-sign entry | | doculog attest approve | PE approval | | doculog attest reject | Request revision | | doculog seal | Apply professional seal | | doculog export | Export entries | | doculog cpd | CPD summary |

Use Cases

Junior Engineer (PE Registration)

1. Create daily entries documenting work performed
2. Submit entries for supervisor counter-signature
3. Track supervisor review ratio
4. Export for PE application submission

Professional Engineer

1. Review and counter-sign subordinate entries
2. Apply PE seal with license number and jurisdiction
3. Generate CPD summary for license renewal

Engineering Manager

1. Monitor team logging compliance
2. Track CPD hours across team
3. Export reports for quality audits

Architecture

doculog/
├── cli/index.js           # CLI entry point
├── commands/              # Command implementations
│   ├── entry/             # Entry management
│   ├── attest/           # Attestation workflow
│   ├── seal.js           # Professional seal
│   ├── export.js         # Export functionality
│   └── cpd.js           # CPD tracking
├── lib/
│   ├── logbook/          # LogbookService core
│   ├── validation/        # Submission requirements
│   └── templates/        # Entry templates
└── ui/                   # Web interface (future)

Related

• DocuMint Repository
• ARIADNE Repository

Install from npm

npm install doculog

License

GNU Affero General Public License v3.0 (AGPLv3)

See DocuMint License for details.