টেকনিক্যাল রাইটিং

## ধাপে ধাপে Technical Writing রোডম্যাপ (৪-৮ মাস) **Month 1 — Technical Writing Foundations:** - What is technical writing: definition, purpose, audience analysis - Types: API documentation, user manuals, SOPs, white papers, release notes, knowledge base articles - Writing principles: clarity, conciseness, accuracy, audience awareness - Plain language guidelines: short sentences, active voice, defined terminology - Grammar and style: subject-verb agreement, parallel structure, punctuation for tech - **Books:** "The Elements of Style" - Strunk & White, "On Writing Well" - William Zinsser - **Resources:** Google Technical Writing Courses (free — developers.google.com/tech-writing) **Month 2 — Docs-as-Code & Modern Tools:** - Markdown mastery: headings, lists, code blocks, tables, links, images, callouts - Git/GitHub for writers: branching, pull requests, version control for docs - Static site generators: Docusaurus, MkDocs, GitBook, ReadMe - API documentation tools: Swagger/OpenAPI, Postman documentation - Content management: Confluence, Notion, Sanity - **Practice:** Write documentation for an open-source project on GitHub **Month 3 — API Documentation Deep Dive:** - REST API concepts: endpoints, methods (GET, POST, PUT, DELETE), status codes - Authentication: API keys, OAuth, JWT tokens - Request/response format: JSON structure, parameters, headers - OpenAPI/Swagger specification writing - Code samples: multiple languages (cURL, Python, JavaScript, PHP) - Error handling documentation - **Practice:** Document a public API (e.g., OpenWeatherMap, JSONPlaceholder) **Month 4 — UX Writing & Product Documentation:** - UX writing: microcopy, error messages, onboarding flows, empty states, CTAs - Voice and tone: brand personality in product copy - Content design: information architecture for help centers - In-app messaging: tooltips, modals, banners, notifications - Style guide creation: terminology, capitalization, formatting rules - Localization basics: writing for translation, cultural considerations **Month 5 — Specialized Technical Domains:** - Software documentation: installation guides, configuration, troubleshooting - SaaS documentation: feature guides, admin docs, integration guides - DevOps documentation: CI/CD pipelines, Docker, Kubernetes guides - Data documentation: database schemas, ETL processes, data dictionaries - Hardware documentation: setup guides, maintenance manuals, spec sheets - **Niche selection:** Pick 1-2 domains to specialize (SaaS, DevOps, Healthcare, Fintech) **Month 6 — Visual Communication in Tech Docs:** - Screenshot best practices: annotations, callouts, redaction - Diagram creation: Lucidchart, Draw.io, Mermaid (Markdown diagrams) - Video documentation: Loom, Camtasia, OBS (screen recording) - Information design: tables, charts, flowcharts, decision trees - Accessibility in documentation: alt text, color contrast, screen reader friendly - Content audit: existing docs assessment, gap analysis - Information architecture: organizing docs, search functionality, navigation - Content lifecycle: creation, review, update, deprecation, archival - Metrics: page views, search queries, feedback scores, support ticket reduction - Single sourcing: content reuse, variables, conditional text - **Tools:** MadCap Flare, Adobe RoboHelp (enterprise), Paligo (structured authoring) **Month 8 — Portfolio & Professional Development:** - Portfolio pieces: API docs, user guide, troubleshooting guide, style guide - Writing samples: ৩-৫ diverse pieces showing range - Personal website: showcase writing, testimonials, services - Certifications: Society for Technical Communication (STC), Certified Professional Technical Communicator (CPTC) - Networking: Write the Docs community, STC chapters, DevRel conferences **Portfolio Projects (must-do):** 1. **API documentation** — OpenAPI spec + interactive docs for a sample API 2. **User manual** — ১৫-২০ page guide for a software product 3. **UX writing samples** — microcopy for an app (onboarding, errors, empty states) 4. **Style guide** — terminology, formatting, voice/tone rules for a fictional company 5. **Knowledge base articles** — ৫টা FAQ/troubleshooting article **কোথা থেকে শিখবে:** - **Free:** Google Technical Writing Courses (developers.google.com/tech-writing — ২টা course, completely free) - **YouTube:** "I'd Rather Be Writing" channel, Write the Docs talks - **Communities:** Write the Docs (writethedocs.org), STC (stc.org), Dev.to technical writing tag - **Books:** "Docs Like Code" - Anne Gentle, "Every Page is Page One" - Mark Baker **English Skill — Critical for Success:** - Technical writing = ৯০% English skill + ১০% technical knowledge - Hemingway Editor — readability score check - Read tech blogs daily: Mozilla Hacks, Stripe Blog, Slack Engineering Blog

## Technical Writing Freelancing Playbook 📝 ### Client কোথা থেকে পাবে: 1. **Upwork** — "Technical Writer", "API Documentation", "User Guide" — steady demand 3. **LinkedIn** — B2B outreach to SaaS startups, developer tools companies 4. **GitHub** — open-source projects need documentation (contributions = portfolio + networking) 5. **Facebook Groups:** "Technical Writers Bangladesh", "Freelancers of Bangladesh" 6. **Content platforms:** Medium, Dev.to, Hashnode — technical articles = visibility + inbound leads 7. **Developer tools companies:** Postman, Stripe, Twilio, Vercel — hire technical writers 8. **Your own blog:** "How to document APIs" type content = authority = client magnet ### আমি client পাবো কি পাবো না? - **পাবো:** Every software product needs documentation — developers hate writing docs - **পাবো না (যদি):** - English weak হলে (technical writing = writing-first profession) - Technical domain knowledge না থাকলে (e.g., Docker docs লিখতে Docker জানতে হবে) - Only generic writing skill — specific niche knowledge needed - **Month 1-2:** Google Technical Writing courses complete করো + open-source project-এ contribute করো - **Month 3-4:** Medium/Dev.to-এ ২-৩টা technical article publish করো (portfolio + visibility) - **Month 7-12:** Niche specialize করো — API docs, SaaS docs, DevOps docs (highest paying) ### High-Paying Niches (specialize in one): ### Bangladesh-Specific Tips: - **Start with local tech companies:** bKash, Pathao, Chaldal — এদের docs improve করার offer করো - **Developer community:** BdOSN, PHP Bangladesh — এদের meetup-এ যাও, networking করো - **Time zone advantage:** BD (UTC+6) overlaps with EU morning + US evening = good for global clients ### Essential Tools (mostly free): - **Writing:** Google Docs, Notion, VS Code (Markdown) - **Docs platforms:** Docusaurus (free), GitBook (free tier), ReadMe - **API docs:** Swagger Editor (free), Postman (free) - **Diagrams:** Draw.io (free), Lucidchart (free tier) ### Pro Tips: - **"Docs or it didn't happen"** — developers know good docs = good product