Training Trains logo

Technical Writing Internship

Write documentation people can follow: tutorials, how-to guides, API references, release notes and a published docs site.

MarkdownGitMkDocs / DocusaurusOpenAPIMermaid

What you'll work on

Full syllabus: all 60 graded tasks

These are the actual tasks the internship portal assigns for this domain. You submit each one with proof (a GitHub link or document) and a mentor reviews it.

Level 1: Foundations (24 tasks)
  1. What technical writers do. Explain the technical writer role and the main document types: tutorials, how-to guides, reference and explanations.
  2. Plain English. Rewrite 5 confusing paragraphs (from manuals or terms pages) in short, clear sentences.
  3. Know your audience. Write the same instruction for a beginner, a developer and a manager, and explain the differences.
  4. Markdown. Write a README in Markdown using headings, lists, links, images, tables and code blocks.
  5. Style guide basics. Summarise 15 rules from the Google developer documentation style guide or Microsoft Writing Style Guide.
  6. Step-by-step how-to. Write a how-to guide for installing Git on Windows with numbered steps and screenshots.
  7. Screenshots and images. Take, crop and annotate screenshots for your guide, with alt text for each.
  8. Edit someone else's writing. Edit a classmate's README for clarity, grammar and structure, and list your changes.
  9. Glossary. Write a glossary of 20 terms for beginners in web development.
  10. Git for writers. Keep your docs in a Git repo named techwriting-internship, using branches and pull requests.
  11. Release notes. Write release notes for an imaginary app update with new features, fixes and known issues.
  12. FAQ page. Write an FAQ with 10 real questions students ask about internships.
  13. Rewrite an error message set. Rewrite 10 confusing error messages so they explain what happened and what to do.
  14. Command-line docs. Document a CLI tool's commands, flags and examples.
  15. Changelog. Write a changelog following Keep a Changelog for three versions of a project.
  16. Contributing guide. Write a CONTRIBUTING.md for an open-source project.
  17. Code comments review. Improve comments and docstrings in a small codebase.
  18. Readability check. Check five documents with a readability tool and improve their scores.
  19. Inclusive language. Review a document for non-inclusive terms and replace them.
  20. Templates. Create templates for a how-to guide, a tutorial and a reference page.
  21. Screenshots style guide. Write rules for screenshots: size, highlighting, sample data and alt text.
  22. Short video guide. Record a 2-minute screen recording with captions for a simple task.
  23. Docs search test. Search for 10 common tasks in a docs site and note which searches fail.
  24. User feedback widget. Add a 'Was this page helpful?' feedback option to your docs site.
Level 2: Building real features (20 tasks)
  1. API reference. Document a public REST API endpoint fully: method, URL, parameters, request, response and errors.
  2. OpenAPI. Write or improve an OpenAPI file for a small API and render it with Swagger UI or Redoc.
  3. Tutorial. Write a beginner tutorial that ends with a working result (for example a to-do app), and test it with someone new.
  4. Docs as code. Publish your docs as a site with MkDocs, Docusaurus or Hugo.
  5. Information architecture. Plan the navigation and page structure of a documentation site for a product.
  6. Diagrams. Draw an architecture diagram and a flowchart with Mermaid or draw.io and embed them in your docs.
  7. Contribute to open source docs. Find a docs issue in an open-source project and submit a pull request to fix it.
  8. Knowledge base article. Write 3 help-centre articles for a common support problem with clear titles and steps.
  9. Video script. Write a script and storyboard for a 2-minute product tutorial video.
  10. Usability test for docs. Watch 2 people follow your tutorial, note where they get stuck, and fix those parts.
  11. SDK reference from code. Generate reference docs from code comments (JSDoc, Sphinx or Javadoc).
  12. Architecture overview for developers. Write an architecture overview of a project for new developers.
  13. Migration guide. Write a migration guide for a breaking change between two versions.
  14. Docs CI. Add link checking and spell checking to your docs in CI.
  15. Versioned docs. Publish docs for two versions of a product on your docs site.
  16. Interview an engineer. Interview an engineer about a feature and turn the notes into a doc they approve.
  17. Concept explainer with diagrams. Write a conceptual explanation of OAuth or DNS with two diagrams.
  18. Help centre structure. Organise 20 help articles into categories with clear titles.
  19. Writing for Indian languages. Translate a short guide into an Indian language and note the challenges.
  20. Docs metrics dashboard. Show page views, feedback and search terms for your docs in a simple dashboard.
Level 3: Professional work and capstone (16 tasks)
  1. Docs review checklist. Create a checklist for reviewing technical docs (accuracy, clarity, examples, links, accessibility).
  2. SDK quickstart. Write a quickstart for using an SDK or library in two programming languages.
  3. Troubleshooting guide. Write a troubleshooting guide with symptoms, causes and fixes for 8 common errors.
  4. Docs metrics. Define how you would measure documentation quality (search success, feedback, support tickets).
  5. Writing with AI responsibly. Use an AI tool to draft a page, then fact-check and rewrite it. Document what the AI got wrong.
  6. Localisation-ready writing. Prepare a guide for translation: simple sentences, no idioms, and a term list.
  7. Real company docs. Write or improve a user guide page for a Training Trains, W3AppDevelopers or DomainHostly feature.
  8. Capstone: documentation portfolio. Publish a docs site with a tutorial, how-to guides, API reference and explanation page, plus a portfolio page linking all your work.
  9. Docs strategy. Write a documentation strategy for a startup: audiences, doc types, tools and ownership.
  10. Content audit. Audit an existing docs site: outdated pages, gaps and duplicates, with a priority list.
  11. API docs with try-it-now. Publish API docs where readers can make test calls.
  12. Docs for AI assistants. Structure docs (llms.txt, clear headings) so AI tools can answer from them correctly.
  13. Training program. Create a short training for developers on writing good READMEs.
  14. Accessibility audit of docs. Audit your docs site for accessibility and fix issues.
  15. Portfolio case study. Write a case study about one docs project: problem, process and results.
  16. Capstone 2: docs for a real product. Produce complete documentation for a real open-source project or a Training Trains/W3/DH feature, reviewed and accepted by its owners.

Real software work, not just training

Every Technical Writing task is reviewed by our team and saved to your portfolio. Interns who pass the readiness check can take real work from Training Trains, W3AppDevelopers and DomainHostly projects on the Company Work board.

Full Stack Web Application Development
See the software we build →

Frequently asked questions

Do I need experience to join the Technical Writing internship?+

Good English writing. Technical knowledge is built through the tasks.

What will I do in the Technical Writing internship?+

You complete 60 graded tasks in three levels: foundations, real features, and professional work. Each task is submitted with GitHub or document proof and reviewed. The final capstone is: Capstone 2: docs for a real product.

Do I get a certificate for the Technical Writing internship?+

Yes. After your required tasks are approved, your attendance is above 75% and you pass the proctored final exam, you get a graded completion certificate that anyone can verify at trainingtrains.com/verify.

Can I do the Technical Writing internship online?+

Yes. You can do it fully online from home, or offline at our Erode and Perundurai branches. Tasks, quizzes and mentor reviews are the same in both modes.

Available both online (work from home) and offline at our Erode and Perundurai branches - see the full internship program details for departments, duration, and the application process.

Apply for the Technical Writing internship