STD-003: File Naming Conventions

Every document in domus-captures MUST use a prefix that identifies its type. Prefixes enable grep-based discovery, chronological sorting, and type-aware processing by AI agents.

Principles

  1. Type is declared in the filename. A reader MUST know what kind of document they’re looking at from the filename alone — before opening it.

  2. Date follows prefix. Format: PREFIX-YYYY-MM-DD-slug.adoc. The date is the creation date, not the last-modified date.

  3. Slugs are kebab-case. Lowercase, hyphens, no underscores, no spaces. Descriptive enough to distinguish from siblings.

Prefix Registry

Prefix Document Type Example

WRKLOG

Daily worklog

WRKLOG-2026-03-24.adoc

MTG

Meeting notes

MTG-2026-02-02-ciso-strategy-session.adoc

DOC

Research / analysis

DOC-2026-03-23-session-knowledge-capture.adoc

PLAN

Roadmaps / plans

PLAN-2026-02-security-tools-learning-roadmap.adoc

REF

Quick reference

REF-2026-02-command-reference.adoc

LRN

Learning / draft

LRN-2026-02-14-cli-data-processing.adoc

INC

Incident report

INC-2026-03-16-001.adoc

CR

Change request

CR-2026-03-12-p50-arch-to-ubuntu.adoc

TAC

Vendor TAC case

TAC-2026-03-chla-8021x-auth-failures.adoc

RCA

Root cause analysis

RCA-2026-03-13-001.adoc

DEPLOY

Deployment record

DEPLOY-2026-01-26-shahab-linux-workstation.adoc

MONTHLY

Month summary

MONTHLY-2026-01-chla-infosec-january.adoc

SETUP

Configuration guide

SETUP-2026-02-01-zfold7-mobile-workflow.adoc

SESSION

Session capture

SESSION-p16g-phase11-validation-2026-04-06.adoc

Requirements

  1. Every chronological document (worklogs, meetings, incidents, changes) MUST include the date in YYYY-MM-DD format immediately after the prefix.

  2. Every document MUST use exactly one prefix from the registry above.

  3. Incident reports and RCAs MUST use a sequential number suffix when multiple occur on the same date: INC-2026-03-16-001.adoc, INC-2026-03-16-002.adoc.

  4. Project documentation (under pages/projects/) follows the project structure standard (STD-001) and does NOT use date prefixes.

  5. Codex, pattern, and reference pages use descriptive names without prefixes (e.g., awk.adoc, systemd.adoc).

Compliance

Check Method Pass Criterion

Prefix is valid

Filename starts with a registered prefix or is in a non-prefixed category (projects, codex, patterns)

No invented prefixes

Date format correct

YYYY-MM-DD immediately after prefix for chronological documents

ISO 8601 date, no variations

Slug is kebab-case

No uppercase, no underscores, no spaces in filename

[a-z0-9-] characters only in slug portion

File in correct directory

Chronological documents in pages/YYYY/MM/, case studies in pages/case-studies/<type>/

File location matches prefix type

Exceptions

Session captures (SESSION-) MAY omit the date from the prefix when the slug contains sufficient context, but SHOULD include it for chronological sorting.

Related