FAQ Writing — Vocabulary and Structure for IT Documentation
Learn vocabulary for writing effective FAQs: question framing, answer structure, and linking strategy.
0 / 10 completed
1 / 10
What makes a good FAQ question format in IT documentation?
Reader-perspective FAQ questions: 'How do I reset my API key?' not 'API Key Reset Procedure.' 'Why is my deployment failing?' not 'Deployment Failure Causes.' Mirror the language users actually type in search bars or ask in Slack. This makes FAQs discoverable and immediately relatable.
2 / 10
What is the appropriate length for a FAQ answer?
FAQ answer principle: answer the question immediately (first sentence), add essential context if needed (2nd-3rd sentence), then link to full documentation for depth. Readers come to FAQs for quick answers — if they wanted a tutorial, they would find a tutorial. Brevity is the highest form of respect for the reader's time.
3 / 10
What is 'last updated' metadata in FAQ maintenance?
Last updated dates are critical in fast-moving tech environments: a reader seeing 'Last updated: 3 years ago' knows to verify externally. A reader seeing 'Last updated: last week' has confidence the information is current. Without last-updated dates, readers cannot calibrate their trust — so they either over-trust stale content or distrust all content.
4 / 10
What is 'answer scent' in FAQ writing vocabulary?
Answer scent: readers scan FAQs quickly. An FAQ with strong answer scent has: a question phrased the way readers think ('Why does my build fail after upgrading Node?'), a clear first sentence that answers directly, and supporting context. Weak scent: generic questions ('How do I use Node?') that could apply to many things.
5 / 10
What is a 'living FAQ' vs. a 'static FAQ' in documentation vocabulary?
Living FAQ: a process for adding new questions (e.g., when the same Slack question appears 3+ times, add it), reviewing and removing outdated answers, and updating answers when the product changes. Static FAQ: written at launch, never touched again, becomes increasingly inaccurate. The key to a useful FAQ is not writing it — it's maintaining it.
6 / 10
Sarah, a junior developer, is drafting a PR description for a bug fix. She writes: 'Fixed a null pointer exception in the authentication service.' Which of the following best describes her phrasing and why?
The original description is purely technical. A good PR description for users (and reviewers) needs to explain *why* this fix matters – what problem was solved and what impact it has on the user experience. Option 1 correctly identifies this gap in the phrasing.
7 / 10
Mark sends a Slack message to his team: 'The API is returning 500 errors.' What's the most helpful follow-up question Mark could ask to diagnose this issue?
While knowing the exact URL is helpful, the immediate priority is understanding *scope*. Option 3 – asking about widespread impact – helps determine if this is a critical issue or something localized. It's better to understand the extent of the problem before diving into technical details.
8 / 10
David is reviewing a code change that implements a new feature for user profile updates. The developer's documentation includes the following FAQ entry: 'How are changes to user profiles stored?' Which of the following best describes the *answer scent* of this question?
'Answer scent' refers to the level of detail expected in a FAQ answer. Option 2 is ideal – it provides a balanced explanation suitable for developers without requiring them to delve into complex SQL or permission details. It focuses on the core data model.
9 / 10
Emily is creating a new FAQ entry about troubleshooting intermittent network connectivity issues with a cloud service. She wants to ensure the entry remains useful over time. What should she include as metadata for this FAQ?
'Last updated' metadata is critical for maintaining FAQs. It indicates when the information was last reviewed and potentially revised to reflect changes in the service or troubleshooting steps. This helps users understand if the advice is still relevant.
10 / 10
John needs to explain the difference between a 'static FAQ' and a 'living FAQ' to his team. Which of the following best describes the key distinction?
The core difference lies in dynamism. A 'living FAQ' actively adapts based on user needs and changes within the product or service – it's continuously refined. A 'static FAQ' remains fixed regardless of updates, making it less effective over time.
What will I practise in "FAQ Writing — Vocabulary and Structure for IT Documentation"?
Learn vocabulary for writing effective FAQs: question framing, answer structure, and linking strategy.
How many exercises are in this module?
This module has 10 multiple-choice exercises, each with instant feedback and a full explanation of the correct answer.
Is this exercise free to use?
Yes. Every exercise on CoderSlingo, including this one, is free to use with no account, sign-up, or paywall.
Do I need to create an account to do these exercises?
No account is required. Just click an option to answer — your score for this session is tracked automatically in the progress bar above.
What happens if I choose the wrong answer?
You'll immediately see which answer was correct, plus a full explanation covering the vocabulary and reasoning behind it — mistakes are where most of the learning happens.
Can I retry the exercises if I want a higher score?
Yes — use the "Try again" button on the results screen to reset and go through all the questions again.
Is my progress saved if I close the page?
No. Progress is tracked only for your current visit; reloading or leaving the page resets the counter. This keeps the exercise simple and account-free.
Where can I find more Knowledge Base Writing exercises?
Browse the full Knowledge Base Writing hub for related drills, or check the "Next up" link below to continue with a connected topic.
How is this different from reading an article on the same topic?
Articles explain vocabulary and concepts in prose; this exercise tests and reinforces that vocabulary through active recall with immediate feedback — the two work best together.
Who writes these exercises?
Every exercise is written by the CoderSlingo team, drawing on real workplace English used in IT roles, then reviewed for accuracy and clarity.