Design verification tooling

DVDocsAgent

An evidence-grounded documentation agent that keeps an Obsidian engineering vault synchronized with a SystemVerilog/UVM repository.

01

Understanding the project

The idea in plain language.

DVDocsAgent tackles a difficult documentation problem: verification code changes constantly, while hand-written architecture and usage notes quickly drift away from the source. The tool analyzes one immutable Git commit, extracts facts it can trace back to exact source blobs, and prepares a reviewed update for an Obsidian vault.

Its priority is trust rather than volume. When the source is ambiguous, oversized, unsafe, or cannot support a claim, the agent reports the gap instead of filling it with a confident guess. Files that do not need to change remain byte-for-byte identical.

02

Core capabilities

What the project can do.

  • 01

    Generates and updates user manuals, reference manuals, a glossary, dependency data, and a synchronization dashboard.

  • 02

    Captures the source branch and commit at the beginning of a run, then reads every analyzed file from that exact commit.

  • 03

    Stages a complete candidate vault and unified diff before touching the real vault, with explicit approve and reject paths.

  • 04

    Preserves engineer-written notes and records why each generated section changed.

  • 05

    Supports Anthropic and OpenAI-compatible providers while keeping credentials outside tracked configuration.

  • 06

    Can resume interrupted runs without duplicating promotion work or commits.

03

Typical workflow

How someone uses it.

  1. 1

    Initialize the project with the DV repository, Obsidian vault, branch, and model provider.

  2. 2

    Run a sync. The agent discovers files, extracts evidence, validates claims, and builds a staged vault at the captured source commit.

  3. 3

    Review the generated patch and report. Approve to promote and commit the update, or reject to leave the vault unchanged.

  4. 4

    Use status, validate, rebuild, and resume commands for day-to-day maintenance and recovery.

04

Under the hood

Technology and design choices.

  • Python 3.11+
  • Git
  • Obsidian Markdown
  • LLM provider APIs
  • LangGraph-style checkpointed workflow

05

Important considerations

What to know before using it.

  • The project is alpha software and retains a human review gate for production documentation.
  • Source-derived content is sent to the configured model provider, so teams must use an endpoint approved for their code.
  • Repository content is treated as untrusted data; source scripts are never executed and suspected credentials are redacted defensively.