Code Documention Generation

Business Context

In software development, maintaining current and comprehensive documentation is crucial yet challenging. At ValueMomentum, our diverse portfolio of applications and client systems across multiple programming languages requires significant resources to keep documentation aligned with rapidly evolving codebases.

Problem Statement

Traditional documentation practices face three main challenges: developers prioritize code delivery over documentation updates, projects require various documentation types, and supporting multiple programming languages increases complexity. This often results in outdated or inconsistent documentation.

Impact and Importance

Our automated documentation solution addresses these challenges by continuously generating accurate, context-aware documentation that evolves with the code. This leads to faster onboarding, improved team collaboration, and more maintainable codebases - ultimately reducing development costs and improving project delivery timelines.

Developer Setup

To set up and run this PoC locally, follow these steps:

1. Ensure you have Python 3.9+ installed on your system.
2. Clone the repository containing the PoC code. Navigate to the folder and install the dependencies:

   pip install -r requirements.txt

3. Navigate to src/flow_manager.py
4. Run flow_manager.py with the following parameters:

   --mode document --source_directory "your base code directory" --target_directory "an empty folder to copy your application with documentation" --ignore "test,init" --extensions ".py"

5. Important Note: If you omit the --target_directory parameter, the documentation will be generated in the original source directory.

Code Documentation Generator Demo