What is Komment
Komment is an automated documentation engine that builds sophisticated technical wikis for your codebase from scratch.
Integrating seamlessly into your CI/CD toolchain, Komment keeps docs continuously in-sync with code as it develops, saving engineering teams countless hours spent manually writing and updating documentation.
Komment collects and organises all your project docs in a centralised Wiki, giving your entire team instant access to reliable information and fresh insights.
Think of it as continuous integration for docs!
What's a documentation engine?
In the context of software, a documentation engine is a tool that automates the creation, management, and maintenance of software docs for a connected codebase.
A doc engine typically takes care of dynamically generating documentation from the source code at various levels of abstraction, including in-code comments, user API docs, architecture diagrams, project READMEs, endpoint details, usage instructions and other technical references.
Doc engines do much of the heavy lifting involved with keeping a codebase understandable and preventing documentation drift — making them an indispensable tool for large teams who want accurate, consistent and fresh software docs across their organization.
What's a wiki?
A Wiki is a centralized knowledge library for your codebase, providing quick and reliable answers about your code. It acts as a single source of truth, ensuring that everyone on your team is working from the same, consistent information.
Each organisation’s Wiki is unique in its structure and the type of documentation it contains, but a Wiki is an essential tool that ensures your team can collaborate seamlessly without worrying about conflicting or outdated details.
Whether you’re onboarding new team members, sharing technical knowledge, or managing ongoing projects, a Wiki offers a frictionless way to collaborate. It helps prevent critical information from being trapped in silos, making it easier to unlock meaningful insights about your code.
Over time a Wiki becomes a repository of organizational knowledge**,** capturing the valuable context and expertise built up within your team.