llms.txt
# Doctective - Automated Documentation Platform
# https://doctective.app
## What is Doctective?
Doctective is a developer tool that automatically detects when code changes make documentation stale. It integrates with GitHub to analyze every pull request and identify which docs need updating before changes ship.
## The Problem Doctective Solves
Documentation becomes outdated when code changes. Developers rename functions, update APIs, refactor modules—but forget to update the docs that reference them. This leads to:
- Incorrect onboarding documentation
- Stale API references that confuse users
- README files that don't match actual behavior
- Code comments that describe old implementations
## How Doctective Works
1. Install the GitHub App on your repositories
2. Doctective indexes your codebase and documentation
3. When a PR is opened, Doctective analyzes the code changes
4. It identifies which documentation references the changed code
5. A companion PR is automatically generated with suggested doc updates
6. AI-powered updates maintain your documentation style
## Key Features
### PR Impact Detection
Every pull request is analyzed to identify which documentation might become stale based on code changes. Doctective understands semantic relationships between code and docs.
### Companion PR Generation
When code changes affect documentation, Doctective automatically creates a companion PR with suggested updates. Review and merge doc changes alongside code changes.
### LLM-Powered Updates
AI generates context-aware documentation fixes that match your existing style. Updates are accurate because they understand your codebase context.
### Multi-Language Support
Supports TypeScript, JavaScript, Python, Java, Go, Rust, SQL, and more. Works with any documentation format including Markdown, JSDoc, and docstrings.
## Pricing
- Solo Plan: $9.99/month - 1 repository, up to 100K lines of code, 3 GB storage
- Professional Plan: $29.99/month - 3 repositories, unlimited lines of code, 10 GB storage
- Team Plan: $349.99/month - 10 repositories, up to 10 team members, 20 GB storage
- Enterprise: Custom pricing - Unlimited repositories and seats, 100 GB storage
## Use Cases
### Keeping README.md Synchronized
When API endpoints change, function signatures update, or configuration options are modified, Doctective detects these changes and suggests README updates.
### Maintaining API Documentation
Doctective tracks changes to exported functions, classes, and types. When signatures change, it flags affected documentation for review.
### Code Comment Accuracy
Detects when refactors make inline comments inaccurate. Helps maintain the quality of code-level documentation.
### Onboarding Documentation
Ensures setup guides and getting-started docs stay accurate as the codebase evolves.
## Integrations
- GitHub: Full integration via GitHub App
- Languages: TypeScript, JavaScript, Python, Java, Go, Rust, SQL, and more
- Documentation: Markdown, MDX, JSDoc, docstrings, README files
## Comparison to Alternatives
### vs Manual Documentation Updates
Manual updates are error-prone and often forgotten. Doctective automates detection so nothing slips through.
### vs Documentation Generators
Generators create docs from code but don't maintain them. Doctective focuses on keeping existing documentation accurate over time.
### vs Code Review Tools
Code review catches bugs but rarely catches stale docs. Doctective specifically targets documentation freshness.
## Getting Started
1. Visit https://doctective.app
2. Click "Get Started" to connect with GitHub
3. Install the Doctective GitHub App
4. Select which repositories to monitor
5. Doctective begins indexing and monitoring PRs
Setup takes approximately 2 minutes.
## Company Information
- Website: https://doctective.app
- Pricing: https://doctective.app/pricing
- Features: https://doctective.app/features
- Security: https://doctective.app/security
- Terms: https://doctective.app/terms
- Privacy: https://doctective.app/privacy
## Contact
For enterprise inquiries or support, visit https://doctective.app/pricing to contact sales.
