Mrs Okafor is not a developer
You wrote: "The routine iterates through the records and returns a flag."
Mrs Okafor runs a sports club. She does not know these words. She cannot decide anything from your sentence.
Clear writing is a skill. It gets you marks. It also shows a client what you built.
Key words
| Word | What it means | Example |
|---|---|---|
| Audience | The people who read or listen to your work. | the club manager |
| Technical | About how the system is built. | a loop, a dictionary |
| Non-technical | Not needing any computer knowledge. | the booking works |
| Jargon | Special words only experts know. | iterate, Boolean |
| Summary | A short version that gives the main points first. | three sentences |
| Portfolio | A folder of your work and your proof. | plans, code, tests |
The cells students fill in are left blank in this preview.
A short report has four parts
- Summary: the answer in three sentences. 2. What I built: what the tool does, in plain words. 3. How I know it works: the tests and what they showed. 4. What next: weaknesses and improvements.
Put the most important thing first. A manager may stop reading after the summary.
A summary, three sentences
| Sentence | What it says | Example |
|---|---|---|
| 1 | What the tool does | The tool lets desk staff book and cancel a court. |
| 2 | Proof it works | It refused every double booking in 11 tests. |
| 3 | What is missing or next | It cannot yet send text messages, which we suggest as the next step. |
The cells students fill in are left blank in this preview.
Quick check: writing for a client
Have a go
Quick check: writing for a client
4 questionsHave a go: your answers are marked here and then forgotten. Sign in if you would like your score kept, and to pick up where you left off.Sign in to keep your score
Your answers are marked here and are not kept. A college account keeps every student’s marks.
Try it: count the words
text = "The tool books a court. It refuses a double booking."
count = 0
for one in text.split("."):
if one.strip() != "":
count = count + 1
print(len(one.split()), "words:", one.strip())
print(count, "sentences")
# Add a long sentence and see its count.
Say it out loud: two minutes
You may need to explain your work aloud or on a recording. Use this plan:
- Say the problem in one sentence. 2. Show the tool doing its main job. 3. Say how you know it works. 4. Say one weakness and what you would do next.
Practise with a friend. Use a clock to time yourself. Look at the listener, not the screen.