Technical Documentation
Develop practical writing habits for READMEs, Jira tickets, design documents, RFCs and ADRs using a realistic project.
Who this example is for
Software engineers and cloud or DevOps professionals who write project documentation and contribute to design discussions.
Example starting level: A2–C1
Adapted after your assessment
Coaching is available at CEFR A2–C1. This is an illustrative plan, not a placement requirement or a promise of a level increase. We adjust the language, tasks and pace to your starting point and priorities.
What you will practise
- Write setup instructions another engineer can follow.
- Describe work in tickets with clear acceptance criteria.
- Organise a design document around the reader’s questions.
- Explain an RFC proposal and record an architectural decision.
Each session combines a workplace task, focused language practice, rehearsal and feedback. Short between-session tasks help you revisit the language. Use fictional or anonymised material, never confidential company information.
Your example 12-week plan
01–12- Week 01
Readers and writing needs
Review an anonymised writing sample. Identify who reads your documents and what they need to do next.
- Week 02
README structure
Draft a project overview, prerequisites and setup steps. Practise direct instructions and consistent terminology.
- Week 03
Instructions and troubleshooting
Write a small installation guide and troubleshooting section. Test whether a reader can follow the sequence.
- Week 04
README revision
Revise your README after reader feedback. Check missing context, ambiguous references and unnecessary jargon.
- Week 05
Jira tickets
Write a bug report with reproduction steps, expected behaviour and actual behaviour, without assuming the reader knows the history.
- Week 06
Epics and acceptance criteria
Break a project goal into an epic and smaller stories. Make scope and completion criteria explicit.
- Week 07
Architectural design docs
Draft a design document covering context, requirements, constraints, options and open questions.
- Week 08
Review comments
Walk through a pull request and respond to review comments. Practise asking for clarification, explaining changes and disagreeing constructively.
- Week 09
Requests for comments
Write an RFC that explains the problem, proposed change, alternatives and the feedback you need.
- Week 10
Architectural decision records
Turn the discussion into an ADR with context, decision and consequences. Distinguish agreed facts from unresolved issues.
- Week 11
Editing for clarity
Revise your document set for sentence structure, consistency and reader navigation. Build a personal editing checklist.
- Week 12
Final documentation review
Submit your README, ticket and design decision for a simulated colleague review. Compare selected passages with your first draft.
How we review progress
A revised README, a Jira ticket and an RFC or ADR, reviewed for completeness, readable instructions and clear decisions.
We compare starting samples, mid-point work and final tasks against goals agreed in your assessment. The focus is clearer communication with international colleagues, not accent imitation or a guaranteed CEFR change.
Start with your own priorities.
Book a free, approximately 30-minute spoken assessment about your work. No test or preparation; camera optional. Coaching is £60 per session and you choose how many sessions you need — 12 is only an example. There is no obligation to continue. See pricing and payment details.
Book Your Free Assessment