Tools and first-week setup

The tools a Technical Writing intern uses and how to set up your workspace in week one.

These are the main tools for Technical Writing tasks. You do not need all of them on day one; the Level 1 tasks tell you when to install each one.

  • Markdown
  • Git
  • MkDocs / Docusaurus
  • OpenAPI
  • Mermaid

Set up your workspace

  • Create a free GitHub account if you do not have one, with a professional username, and set up your LinkedIn profile: every task is submitted with a LinkedIn post.
  • Create one repository for the internship, for example technical-writing-internship, with a README that says who you are and what the repo holds.
  • Keep one folder per task, named with the task number and title, so mentors find your work quickly.
  • Commit small changes every day with clear messages. Your daily work report uses these commits as proof.
  • Never commit passwords, API keys or personal data. Put secrets in a .env file and add it to .gitignore.

Your first tasks

TaskWhat to do
What technical writers doExplain the technical writer role and the main document types: tutorials, how-to guides, reference and explanations.
Plain EnglishRewrite 5 confusing paragraphs (from manuals or terms pages) in short, clear sentences.
Know your audienceWrite the same instruction for a beginner, a developer and a manager, and explain the differences.
MarkdownWrite a README in Markdown using headings, lists, links, images, tables and code blocks.
โ† What a Technical Writing intern doesAll 60 tasks, level by level โ†’