Skip to content

yumiyagawa/6-Figure-Tech-Writer-Resource-Hub

 
 

Repository files navigation

QW LinkedIn banner (7)

The 6-Figure Tech Writer Resource Hub ⭐📄

Welcome!

Here is the current roadmap for this growing Resource Hub. Please feel free to fork this repo and open a pull request if you'd like to suggest additional resources or topics.

Happy documenting,

Quetzalli

Tech-Writing-Resource-Hub-Roadmap/
│
├── README.md                    # Overview of the repo and how to use it
├── CONTRIBUTING.md               # Guidelines for how others can contribute
├── CODE_OF_CONDUCT.md            # Code of conduct for contributions
├── templates/                    # Templates for various tech writing documents
│   ├── api-doc-template.md       # API Documentation template
│   ├── release-notes-template.md # Release Notes template
│   ├── tech-tutorial-template.md # Technical Tutorial template
│   ├── product-doc-template.md   # Product Documentation template
│   ├── whitepaper-template.md    # Whitepaper template
│   └── case-study-template.md    # Case Study template
│   └── onboarding-docs-template.md  # Onboarding template for users
├── glossaries/                   # Glossaries for key terms in tech writing
│   └── tech-writing-glossary.md  # Glossary for tech writing terms
├── checklists/                   # Useful checklists for tech writing activities
│   ├── api-doc-checklist.md      # Checklist for API documentation completeness
│   ├── release-notes-checklist.md# Checklist for writing effective release notes
│   ├── tutorial-checklist.md     # Checklist for writing technical tutorials
│   └── product-docs-checklist.md # Checklist for creating product documentation
├── tools/                        # Interactive or downloadable tools
│   ├── glossary-generator.js     # Python script to generate glossaries from text
│   ├── api-doc-generator.py      # Script to auto-generate API docs from JSON/YAML
└── resources/                    # Links to articles, books, and talks
    ├── articles.md               # Curated list of articles on technical writing
    ├── books.md                  # List of recommended books for tech writers
    └── videos.md                 # Talks and presentations related to tech writing

About

Educational resources, code examples, interview exercises, and templates for tech writers ready to ditch crappy pay.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors