InternshipKey terms and common mistakes
The words you will hear in Technical Writing work and the mistakes that most often cost interns approvals.
Key terms
| Term | Meaning |
|---|---|
| Docs-as-code | Writing docs in Markdown and managing them in Git like code |
| Style guide | Rules for tone, terms and formatting |
| API reference | Exact description of every endpoint, parameter and error |
| Tutorial | A guided lesson that builds something step by step |
| How-to guide | Steps to finish one specific task |
| Information architecture | How docs are organised and found |
| Release notes | What changed in a version, for users |
| Readability | How easily a reader understands the text |
Common mistakes to avoid
- Writing for yourself instead of the reader.
- Steps that skip prerequisites or setup.
- Screenshots and code that are out of date.
- Long paragraphs where a numbered list would be clearer.
Want to go deeper? The free Software Engineering & SDLC learning path has short modules, games and a certificate for each module.