Skip to main content

Project Documentation

Deflectra allows you to generate and maintain a complete documentation of your project automatically. This feature is designed to give you a deep understanding of your codebase and its structure without manual effort.

What's Included​

The generated documentation is comprehensive and includes:

  • Detailed Tables: Clear and structured data representing your project's components.
  • Endpoint Overview: A full list of identified endpoints and their characteristics.
  • Dynamic Flow Graphs: Visual representations of logic flows using GraphViz. This includes:
    • Authentication flows to understand how your app secures access.
    • Endpoint call chains to trace data through your system.
    • Logic dependencies and more.

Deflectra AI Docs

Deflectra AI Graph

Exporting Your Documentation​

All documentation is saved locally and can be accessed within the Deflectra interface.

PDF Export​

For users who need to share reports with stakeholders or keep offline archives, Deflectra offers the ability to export the entire documentation to PDF.

note

PDF Exporting is an exclusive feature of Deflectra Premium. To unlock this and other advanced AI features, check out the Upgrade to Premium section.