mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-16 06:12:41 -05:00
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.
5.9 KiB
5.9 KiB
Reading List
Essential articles, guides, and resources for documentation professionals, technical writers, and content creators.
Documentation Strategy & Best Practices
Core Principles
- What nobody tells you about documentation - The four types of documentation
- Systematic approach to technical documentation authoring - The Diátaxis framework
- Let's Get Intentional About Documentation - Strategic documentation planning
- Maybe it's time we re-think docs - Rethinking documentation approaches
Industry Examples
- Documentation That Developers Actually Read: The Netflix Approach - Netflix's documentation strategy
- How Google, Twitter, and Spotify built a culture of documentation - Building documentation culture
Technical Writing Skills
Writing Fundamentals
- Writing great documentation - Core principles of great docs
- Become a better writer as a developer - Developer writing skills
- How to write technical posts - Technical blog writing
- Writing Technical Stuff for Non-Technical Readers - Audience-focused writing
Content Creation
- Write good examples by starting with real code - Creating effective code examples
- Document Like a Scientist - Scientific approach to documentation
- User Guide Template - User guide structure
Specialized Topics
API Documentation
- API Guidelines - Comprehensive API design guidelines
- API Handyman - API design and documentation insights
- API Knowledge - API knowledge base
- Tips for better documentation with OpenAPI - OpenAPI best practices
- What we can learn from UX professionals when designing APIs - UX principles for APIs
- Zalando RESTful API and Event Guidelines - Enterprise API guidelines
User Experience & Design
- A Guide to Creating Personas - User persona development
- A simple technique for evaluating content - Content evaluation methods
- An examination of translating text to make it as accessible as possible - Plain language analysis
Accessibility & Inclusion
- Automating Your Accessibility Tests - Accessibility testing automation
- Why does inclusive language matter - Inclusive language importance
Content Tools & Techniques
Language & Style
- Setting up the alex.js language linter in your project - Automated language checking
- Semantic Line Breaks - Line break methodology for prose
- Grammarly Blog - Writing tips and grammar insights
Technical Implementation
- Mastering cURL - cURL for API documentation
- Great Developer Documentation Examples - Documentation inspiration
Analytics & Measurement
- Where to start with analytics for documentation - Documentation analytics basics
Career Development
Getting Started
- Become a technical writer - Career transition guide
- Free Resources to Learn Technical Writing - Learning resources
Professional Development
- Google - Technical Writing Courses - Free Google courses
- Technical Documentation in Software Development - Enterprise documentation
- Technical Documentation Tool and Web Guide - Tool selection guide
Community Resources
Documentation Communities
- Scottydocs.com - Documentation community resources
- Awesome Documentation - Curated documentation resources
- Tools for Technical Writers - Technical writing tool collection
This reading list provides a comprehensive foundation for anyone looking to improve their documentation skills, understand best practices, and stay current with industry trends. Start with the core principles and expand into specialized areas based on your interests and needs.