mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-24 09:11:51 -05:00
sven
d2eb3c152e
Move topic pages to section index routes, standardize card-based content presentation, and simplify metadata typing while improving local search indexing for EnhancedLink entries. Refresh theme styling and replace unstable external links to keep metadata builds reliable.
2.8 KiB
2.8 KiB
AI Writing
AI-powered writing assistants, agent skills, and prompt resources for technical writing workflows.
AI Writing Assistants
Tools that use AI to help you write, edit, and improve documentation.
General Purpose
- Grammarly - AI-powered writing assistant with grammar, style, and tone suggestions
- LanguageTool - Open-source grammar and style checker with AI-enhanced suggestions
- QuillBot - AI paraphrasing and rewriting tool useful for simplifying complex technical content
Technical Writing Focused
- GitHub Copilot - AI pair programmer that also assists with writing documentation, README files, and inline code comments
- Mintlify Writer - AI-powered documentation writer that generates docs from code
- Swimm - AI-assisted documentation platform that keeps docs synchronized with code
AI Editors & Integrations
- Cursor - AI-first code editor with strong support for editing Markdown and documentation files
- Zed - High-performance editor with AI assistant integration for writing tasks
Agent Skills & Prompts
Prompt templates, system prompts, and agent skill patterns for technical writing workflows.
Prompt Libraries
- Awesome ChatGPT Prompts - Community-curated prompt collection including technical writing prompts
- Fabric - Open-source framework for augmenting humans with AI, includes patterns for writing and summarization
Technical Writing Prompt Patterns
Effective prompt patterns for common technical writing tasks:
- Draft from outline — Provide a structured outline and ask the AI to expand each section with appropriate technical depth
- Simplify for audience — Paste complex content and specify the target audience (e.g., "rewrite this for a developer unfamiliar with Kubernetes")
- Generate examples — Ask the AI to produce code examples or step-by-step walkthroughs for a concept you've described
- Review for clarity — Ask the AI to identify sentences that are ambiguous, overly passive, or unnecessarily complex
- Terminology consistency — Provide a glossary and ask the AI to flag inconsistent term usage in a document
AI Writing with Roo/Claude Skills
If you use AI coding assistants with skill/tool support, technical writing skills can be defined to:
- Enforce house style rules during drafting
- Generate structured documentation from code or API specs
- Produce first drafts of changelogs, release notes, or how-to guides
For non-AI writing tools, see Writing Tools. For AI-powered review and linting, see AI Review.