Documentation

Keep Knowledge Aligned With the System

Software documentation often becomes outdated because it is maintained separately from the system it describes.

HexaKernel approaches documentation differently.

The domain specification provides a structured source from which documentation and other knowledge artifacts can be derived.

One Domain, Consistent Knowledge

The same specification can describe:

What exists.

How things relate.

What rules apply.

What operations are possible.

How entities change.

What events occur.

This knowledge can support documentation for both technical and business audiences.

Documentation as a Derived Artifact

When the domain changes, its derived knowledge can change with it.

This reduces the distance between:

What the business says.

What the documentation says.

What the software does.

The specification provides the connection.

Human and Machine Knowledge

Documentation is not only for developers.

The same domain knowledge can support users, operators, AI agents, support systems and knowledge bases.

This creates a broader idea of documentation:

the domain becomes structured knowledge that can be consumed by both humans and machines.

When the source of truth changes, the knowledge built from it can evolve too.