Skip to content

vibgrate/holistic-code-specification

Repository files navigation

Holistic Code Specification

Welcome to the Official Holistic Code Specification (HCS) Interpreter's Guide

This is the home of the complete Holistic Code Specification (HCS) reference documentation aimed at interpretation roles.

These documents provide all the information needed to understand and interpret HCS files — the structured-English, evidence-linked, pattern-compressed system blueprints generated from source code.

Document Index

Document Purpose
Overview of HCS What HCS is, its purpose, core concepts, and holistic dimensions
Language Reference Grammar, syntax, keywords, casing rules, and statement schemas
Intermediate Model Machine-facing data model, types, and evidence structures
HCS Fact Types Complete taxonomy of fact types captured from source code
HCS Patterns Pattern system, type system, expansion templates, and standard library
Changelog Version history and release notes

Reading Order

For comprehensive understanding:

  1. Start with Overview of HCS to understand what HCS is and why it exists
  2. Read Language Reference to understand the DSL syntax
  3. Study Intermediate Model to understand the underlying data structures
  4. Reference HCS Fact Types for the evidence taxonomy
  5. Consult HCS Patterns for pattern compression and expansion

Key Concepts

HCS is NOT documentation

HCS is a specification artifact with:

  • Structured English statements
  • Typed semantics (every statement maps to a machine-checked schema)
  • Traceability (every claim links back to evidence in code)
  • Pattern compression (common idioms collapse into named patterns)

Reproducibility

A system is reproducible from HCS when it contains enough detail to regenerate:

  • Domain behaviour (use-cases and workflows)
  • Interface contracts (UI + APIs + message schemas)
  • Data structures (entities, constraints, relationships)
  • Security posture (auth flows, authorization rules, boundaries)
  • Integration behaviour (calls, retries, timeouts, idempotency)

© 2026 Vibgrate. All rights reserved. | License | vibgrate.com

About

Holistic Code Specification (HCS) is a structured-English, evidence-linked, pattern-compressed system blueprint generated deterministically from code, designed to be complete enough for migration and faithful reimplementation.

Resources

License

Stars

Watchers

Forks

Contributors