Skip to content

nomi25home/WriteThatDown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

WriteThatDown

A browser extension for Chrome that allows you to record a sequence of user actions and automatically generate a step-by-step user guide with screenshots.

Features

  • Action Recording: Captures clicks and interactions in real-time.
  • Automatic Descriptions: Generates human-readable descriptions for each captured event.
  • Visual Guides: Creates a clean HTML guide with screenshots and click indicators.
  • Customization:
    • Edit step descriptions directly in the exported guide.
    • Reorder steps using "Move Up" and "Move Down" buttons.
    • Delete unwanted steps from the guide and underlying storage.
    • Redaction mode to hide sensitive information in screenshots.
  • Multiple Export Formats: Export as HTML or Markdown.

Installation

  1. Clone this repository.
  2. Open Chrome and go to chrome://extensions/.
  3. Enable "Developer mode" in the top right corner.
  4. Click "Load unpacked" and select the project folder.

How it Works

  • Background Script: Manages the recording state and persists events to chrome.storage.local.
  • Content Script: Listens for user events on the page and sends them to the background script.
  • Popup: Provides the user interface to start/stop recording and export the final guide.

Future Scope

  • AI-Powered Smart Descriptions: Implement contextual awareness and local LLM integration (via Ollama) to generate higher-quality, human-like instructions.
  • Interactive Guide Editor: Build a dedicated editor page within the extension to manage, reorder, and refine guides in real-time before exporting.

Acknowledgments

Built with the assistance of Claude and Ollama.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors