Skip to content

paras55/documentation_writer_agent_team

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🧠 Technical Documentation AI Agent Team

This project automates the generation of technical documentation using a multi-agent AI workflow. It simulates a complete research, execution, and writing pipeline based on user queries β€” ideal for guides, how-tos, and tutorials.

πŸš€ Features

  • Task Decomposition: Breaks down a user query into logical steps using GPT-4o.
  • Automated Browser Execution: Uses a headless Chrome browser to perform tasks and capture screenshots.
  • Image Analysis: Describes screenshots using Gemini or GPT-4o.
  • Research Context: Pulls background information using Perplexity API.
  • Technical Guide Writer: Generates a polished, structured guide in Markdown format.

πŸ› οΈ Requirements

  • Python 3.10+
  • Chrome installed (adjust chrome_path if necessary)
  • Environment Variables:
    • OPENAI_API_KEY
    • PERPLEXITY_API_KEY
    • GOOGLE_API_KEY (for Gemini)

πŸ“¦ Installation

  1. Clone the repo and install dependencies:
pip install -r requirements.txt
  1. Create a .env file with your API keys:
OPENAI_API_KEY=your_openai_key
PERPLEXITY_API_KEY=your_perplexity_key
GOOGLE_API_KEY=your_google_api_key
  1. Make sure the Chrome path is correct (Mac default included in code).

πŸ§ͺ How It Works

  1. You enter a query describing a goal (e.g., "Generate a prompt response guide").
  2. The system:
    • Breaks it into steps
    • Executes the task in a headless browser
    • Captures and analyzes screenshots
    • Summarizes execution and writes a Markdown guide

πŸ“‚ Output

  • Screenshots are saved to /screenshots
  • A Markdown guide is saved as draft.md

πŸ–₯️ Running the Program

python main.py

Then enter your query when prompted.

πŸ“Έ Screenshots & Recording

Optionally, you can modify the script to enable or disable GIF recording or change viewport behavior.

✨ Example Queries

  • "Create a guide on exporting JSON from Postman"
  • "Write a walkthrough on using GitHub Actions for CI"

Built with ❀️ using OpenAI, Google Gemini, and Perplexity AI.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages