proofread

Proofread markdown documents with aspell and Google AI language models.

9|1|Updated Jul 19, 2022

Search Tags:#editing #LLM #writing assistant #proofread #grammar check #spell check

Ready to run

npx skills add https://github.com/benthamite/dotfiles --skill proofread-benthamite

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: proofread
Source: https://github.com/benthamite/dotfiles/tree/main/claude/skills/proofread
Command: npx skills add https://github.com/benthamite/dotfiles --skill proofread-benthamite

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @ai-sdk/google, ai, dotenv, zod, and includes scripts (resource) components.

What problem does it solve?

This Skill enhances written content by identifying and correcting errors in spelling, grammar, punctuation, style, and clarity, ensuring professional and polished communication.

Core Features & Use Cases

Dual-Engine Approach: Offers both a fast, deterministic aspell-based spellchecker and a thorough AI-powered LLM engine (Gemini Flash) for comprehensive review.
Configurable Levels: Choose between mechanical checks, light style passes, or comprehensive proofreading.
Use Case: Improve a draft article by using the LLM engine to not only fix typos but also suggest clearer phrasing and more concise sentence structures, making the final piece more impactful.

Quick Start

Use the proofread skill to perform a light style pass on the attached document 'my_article.md'.

Frequently Asked Questions about proofread

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I proofread markdown documents for grammar and spelling errors?▼

You can proofread markdown documents by using a dual-engine approach that combines deterministic aspell spellcheck with AI-powered LLM review to correct spelling, grammar, punctuation, style, and clarity errors.

What's the best way to check writing style and clarity in markdown files?▼

Checking writing style and clarity in markdown files is best handled by an AI-powered LLM engine like Gemini Flash, which provides comprehensive proofreading beyond mechanical spellcheck passes to suggest clearer phrasing.

Do I need a Google AI API key to run automated LLM proofreading?▼

Yes, you need a Google AI API key to run automated LLM proofreading. The AI-powered engine requires this key to access the Gemini Flash model for comprehensive grammar, style, and clarity review.

Can I use aspell for deterministic spell check alongside an AI writing assistant?▼

Yes, you can use aspell for deterministic spell check alongside an AI writing assistant. This dual-engine approach offers both fast mechanical spellchecking and thorough LLM-powered language review.

What levels of automated proofreading can I configure for draft articles?▼

You can configure automated proofreading across multiple levels, choosing between mechanical checks for spelling, light style passes for phrasing, or comprehensive proofreading for overall clarity and grammar.