Home / Use cases / Internal documentation

COMPANIES

Documentation should be portable even when the documentation tool is not.

Keep internal knowledge as readable files instead of another application silo.

The problem

Systems, how-tos and glossaries often live in a tool that is easy to edit and difficult to leave. Agents then need a second copy.

What goes in the repository

  • Systems
  • Processes
  • Reference docs
  • Glossaries
  • Architecture
  • How-tos
  • Policies
docs/
├── index.md
├── systems/
├── how-to/
├── reference/
└── glossary/

Why an open repository helps

Readable files can serve people, search and agents without a separate export for each.

How Okide helps

Okide is an editor for that documentation, not a container that replaces the files.

Humans and agents, same files

The same documentation can serve people, search systems and agents without requiring a separate knowledge copy for each.

OPEN BY DEFAULT

Keep the repository. Change the tools around it.

If the documentation tool goes away, the documentation should still open. Okide helps you work with the repository without turning it into an Okide-only format.