mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-21 04:03:48 -05:00
sven
0f86629cd3
Created comprehensive pages for all sections referenced in navigation: - writing.md: Writing tools, editors, knowledge bases, mockup tools, screenshots, screencasts, and learning resources - style-guides.md: Complete collection of style guides from government, tech companies, and specialized domains - reading.md: Essential articles, guides, and resources organized by topic (strategy, skills, APIs, UX, accessibility, etc.) - github-actions.md: GitHub Actions for documentation validation, content generation, and quality assurance with workflow examples - tools.md: Additional specialized tools covering AsciiDoc, browser testing, accessibility, hosting, utilities, and analytics Updated VitePress config: - Added all new pages to navigation menus - Organized tools into logical categories - Fixed 404 errors for previously missing routes Content migration status: - All major sections from README.md now have dedicated pages - Navigation links properly connected to existing content - Structured content with clear categories and descriptions - Cross-references between related sections This completes the content migration from the original README.md structure to a comprehensive VitePress documentation site.
3.2 KiB
3.2 KiB
Writing Tools
Tools and resources for improving technical writing, grammar, and content creation.
Writing & Grammar Tools
Browser Extensions
- Grammarly - AI-powered writing assistant
- LanguageTool - Grammar and style checker
- QuillBot - Paraphrasing and writing tool
Editors
- HackMD - Collaborative markdown editor
- Lapce - Fast code editor
- Mark Text - Real-time markdown editor
- Swimm - Documentation platform for code
- Visual Studio Code - Popular code editor
- Zed - High-performance code editor
- Zettlr - Academic writing and note-taking
Knowledge Base
Content Creation
Mockup & Visualization
- Animockup - Create animated mockups
- Excalidraw - Hand-drawn like diagrams
- Markmap - Visualize markdown as mind maps
Screenshots & Screencasts
- Carbon - Beautiful code screenshots
- Flameshot - Screenshot tool
- shot-scraper - Command-line screenshots
- Shottr - macOS screenshot annotation
Screencast Tools
- Asciinema - Record terminal sessions
- Codio - Interactive coding presentations
- Editly - Programmatic video editing
- Kap - Screen recorder for macOS
- Peek - GIF screen recorder for Linux
- Screenity - Browser screen recorder
- Terminalizer - Record terminal sessions as GIF
Learning Resources
Guides & Articles
- How to write a basic how-to - Red Hat guide
- How to write a README - README best practices
- Words matter - Inclusive language guide
Courses & Training
- Google Technical Writing Courses - Free technical writing courses
- Become a technical writer - Career guidance
- Free Resources to Learn Technical Writing - Learning resources
Related Tools
Feedback & Analytics
- Papercups - Customer messaging platform
Accessibility
For accessibility-focused writing tools, see our Quality Assurance section.
Content Validation
For spell checking and content validation tools, see our Quality Assurance section.