Documan FAQs

Question 1

Is Documan suitable for CI/CD pipelines?

Accepted Answer

Yes, Documan offers robust documentation linting and validation commands. These can be integrated into your CI/CD pipelines to automatically check for required frontmatter, broken links, and other consistency issues without modifying files.

Question 2

How does Documan integrate with AI coding tools?

Accepted Answer

Documan includes an MCP (Multi-Modal Coder Protocol) server. This server allows AI coding tools like Claude Code CLI and Cursor IDE to perform semantic searches and access your documentation directly, enhancing your coding workflow.

Question 3

What kind of files does Documan use for documentation?

Accepted Answer

Documan primarily uses Markdown files for documentation. It automates the generation and standardization of frontmatter for these files, ensuring consistent metadata and structure across your project.

Question 4

What is Documan and what does it do?

Accepted Answer

Documan is a command-line tool that generates and serves a web documentation site directly from your project's Markdown files. It enables quick setup, automated content management, and integration with AI coding tools.

Question 5

How quickly can I set up and view documentation with Documan?

Accepted Answer

Documan is designed for rapid setup, featuring single-command installation and operation. You can quickly generate, import, and serve your documentation to view it in a web browser almost immediately after initial configuration.

Documan

概要

主な機能

ユースケース

Documan

概要

主な機能

ユースケース