FAQ Writing — Vocabulary and Structure for IT Documentation
Learn vocabulary for writing effective FAQs: question framing, answer structure, and linking strategy.
0 / 5 completed
1 / 5
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 / 5
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 / 5
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 / 5
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 / 5
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.