Skip to content

React web app that writes technical docs for your project using the evaluator-optimizer pattern, an LLM-based agent-like looping workflow.

License

Notifications You must be signed in to change notification settings

mmacy/tech-doc-workflow

Repository files navigation

Tech Doc Workflow

Demonstration of using the evaluator-optimizer workflow for technical documentation authoring. Built with Google AI Studio and Claude Code.

Web browser showing the main page of the Tech Doc Workflow app during a doc authoring and revision run. The Technical Editor role is in the Waiting state while the Technical Writer integrates the Editor's feedback.

Prerequisites

  • Node.js

Workflow roles

Diagram of the draft revision and feedback flow between the technical writer, technical reviewer, information architect, and technical editor workflow roles

Run the app locally

  1. Install dependencies: npm install
  2. Run the app: npm run dev
  3. Configure your API keys through the application's settings interface

About

React web app that writes technical docs for your project using the evaluator-optimizer pattern, an LLM-based agent-like looping workflow.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •