Doclific

Product Introduction

1. Definition: Doclific is an open-source documentation tool designed for software development teams. It operates as a repository-native solution, embedding all technical documentation directly within the codebase using Markdown-like syntax and AI automation.
2. Core Value Proposition: Doclific eliminates documentation drift by synchronizing docs with code changes. Its core innovation lies in local-first architecture and automated CI workflows, ensuring engineers access accurate, version-controlled docs without external tools or context switching.

Main Features

1. Notion-like Editor:

   • How it works: Engineers write docs using rich text formatting (headings, lists, tables) and embed live code snippets via file-path references (e.g., @/src/utils/auth.js). Built on Plate.js and React Flow, it supports drag-and-drop diagramming.
   • Technologies: React-based editor with shadcn/ui components.

2. AI-Powered Documentation:

   • How it works: Users prompt AI (currently Google Gemini) to generate docs. For example, typing /generate erd auto-creates an Entity Relationship Diagram by analyzing schema files.
   • Technologies: Gemini API integration; future support for OpenAI/Anthropic.

3. Dynamic Code Snippets:

   • How it works: Snippets reference actual repository files. During CI runs, Doclific’s scanner detects code changes (e.g., line shifts) and auto-updates snippet line numbers or flags discrepancies.
   • Technologies: Custom CI tooling with Git hooks.

4. ERD & Architecture Whiteboarding:

   • How it works: AI converts SQL schema files into visual ERDs. Interactive whiteboards let teams diagram system flows with real-time collaboration.
   • Technologies: React Flow for diagrams; Lucide Icons.

5. Local-First Execution:

   • How it works: Runs entirely on-device via a CLI tool. Zero data leaves the machine, ideal for air-gapped environments.
   • Technologies: Installable via bash script (curl -fsSL ...).

Problems Solved

1. Pain Point: Documentation drift caused by code/docs decoupling. Traditional tools (Confluence, Notion) lack version sync with repositories.
2. Target Audience:
   • Software Engineers needing in-repo docs for rapid onboarding.
   • DevOps Teams automating compliance documentation.
   • Open-Source Maintainers requiring contributor-friendly guides.
3. Use Cases:
   • Visualizing microservice interactions via auto-updated architecture diagrams.
   • Generating audit-compliant ERDs during database migrations.
   • Enforcing docs/code parity in CI/CD pipelines.

Unique Advantages

1. Differentiation: Unlike Sphinx or Docusaurus, Doclific avoids static-site generation. It embeds docs as living files in repos, whereas competitors (Swimm) rely on cloud syncing.
2. Key Innovation: CI-Driven Auto-Correction – Detects snippet line-number shifts during pull requests and self-heats docs without manual edits.

Frequently Asked Questions (FAQ)

1. How does Doclific prevent documentation drift?
   Doclific embeds docs in your repository and uses CI checks to auto-update code snippets when line numbers change, ensuring docs match code commits.

2. Is Doclific suitable for large codebases?
   Yes, its local-first design scales efficiently, and dynamic snippets reduce manual doc maintenance overhead for enterprise repositories.

3. Can Doclific generate ERDs from existing databases?
   Doclific’s AI analyzes schema files (SQL/Prisma) to auto-create ERDs, with manual tweaks via its whiteboard editor.

4. What AI models does Doclific support?
   Currently Google Gemini, with OpenAI and Anthropic integrations planned for automated doc generation.

5. How secure is Doclific for proprietary code?
   All processing occurs locally; no code/docs are transmitted externally, making it ideal for sensitive IP environments.