WriteRight Pro is a professional Chrome Extension designed to audit technical documentation based on the Diátaxis framework. It helps technical writers and developers ensure their content is structurally sound, clear, and user-centric.
- Structural Audit: Analyzes text to determine if it aligns with Diátaxis pillars (Tutorial, How-to, Reference, or Explanation).
- Technical Scoring: Generates an architecture score for documentation quality.
- Actionable Feedback: Provides prioritized recommendations (High, Medium, Low) to improve content organization.
- Local History: Saves past reviews locally using Chrome Storage for quick reference.
- Secure API Integration: Communicates with a dedicated Vercel backend for high-performance AI analysis.
The project is organized as follows:
/background: Contains service workers and API communication logic./popup: User interface files (HTML, CSS, and JS) for the extension window./icons: Brand assets and extension icons for various resolutions./lib: Core engines, including the Diátaxis analysis logic and payment integration.manifest.json: The extension's configuration file (Manifest V3).privacy.html: Official privacy policy required for the Chrome Web Store.
- Google Chrome Browser.
- Access to the WriteRight Backend hosted on Vercel.
- Clone this repository.
- Open Chrome and navigate to
chrome://extensions/. - Enable "Developer mode" in the top right.
- Click "Load unpacked" and select the root directory of this project.
Payment processing and subscription management are handled via Gumroad.
- Plan: Unlimited Technical Audits.
- Price: $10.00 / year.
This is a private repository. All rights reserved to Mauro Buffalo.