unearth.wiki

Self-Documentation

/sɛlf dɒkjʊmɛnˈteɪʃən/ Embedded Ontology
Definition The capacity of a system or artifact to explain its own purpose, structure, and operation. In Archaeobytology, this refers to files or codebases that contain their own keys to decipherment (e.g., plain text headers, semantic variable names, embedded schemas), ensuring they remain legible even after the original context is lost.

The Lost Manual Problem

Most digital decay happens not because the data is lost, but because the context is lost. We have the bits, but we don't know what they mean. External documentation (manuals, wikis) often becomes separated from the artifact.

Self-Documentation solves this by placing the "Rosetta Stone" inside the file itself. A JSON file is more self-documenting than a binary blob. A literate code file is more self-documenting than a minified script.

Code as Literature

Through the lens of Text / Textile, code is a form of writing meant to be read by humans first, and machines second. Self-documenting code uses clear logic and explanatory comments to bridge the gap between author intent and future reader understanding.

Stratigraphy (Related Concepts)
Tacit Knowledge Bioluminescence Text / Textile Archaeobyte