Clarity & Conciseness
As a content designer, your role is to make complex information simple and accessible. Clarity is your most powerful design tool—it reduces cognitive load and creates better user experiences.
The Content Designer's Perspective
Content design is about understanding user needs and presenting information in the clearest, most helpful way possible. Every word choice, sentence structure, and paragraph matters.
Design Principles for Clear Content
1. Know Your User
Before writing, define your audience:
- What do they need to do?
- What's their technical level?
- What problems are they solving?
- How much time do they have?
2. One Idea Per Paragraph
Each paragraph should contain one main idea:
❌ Too Much:
To reset your password, click the Settings button in the top right, then select Security. You'll see a Password Reset option. Make sure your new password is at least 12 characters and includes numbers, letters, and symbols. If you forget your password again, you can use the forgot password link.
✅ Clear:
Click Settings > Security > Reset Password.
Your password must have:
- At least 12 characters
- Numbers, letters, and symbols
3. Use Microcopy Strategically
Microcopy is small text that guides users:
Button: "Save Changes" (not "Submit Form")
Error: "Email not found. Try another." (not "Invalid input")
Success: "Invitation sent!" (not "Action completed")
4. Write for Scanning
Users scan instead of reading every word:
✅ Scannable:
Getting Started
- Create an account
- Connect your device
- Set preferences
Troubleshooting
- Device won't connect?
- App keeps crashing?
- Password issues?
Content Design Best Practices
Use Progressive Disclosure
Show information in layers:
- Headline - What is this?
- Subheading - Why should I care?
- Body - How do I use it?
- Advanced - Power user features (hidden by default)
Choose Your Words Carefully
| ❌ Corporate | ✅ Conversational |
|---|---|
| Facilitate | Help |
| Utilize | Use |
| Navigate | Go to |
| Submit | Send |
| Initialize | Start |
Match Tone to Context
- Instructional: Direct and confident
- Error messages: Helpful and actionable
- Success: Positive and encouraging
- Warnings: Clear and serious
Active, Imperative Mood
Tell users what to do:
❌ Passive:
A backup should be created before updating.
✅ Active:
Create a backup before updating.
Design for Accessibility
Clear content is accessible content:
- Short paragraphs (3-4 lines max)
- Simple words everyone understands
- Avoid ALL CAPS except acronyms
- Use lists instead of walls of text
- One task per instruction
Testing Your Content
Ask Real Users
- Can they find what they need?
- Do they understand the instructions?
- What's confusing?
- What should we remove?
Content Audit
Regularly review your content:
- Remove outdated information
- Fix confusing sections
- Update examples
- Improve based on user feedback
Core Principles
Estimated reading time: 4 min
Skill level: Beginner – Intermediate
What you'll learn
- How to identify and write for your audience
- Techniques for clarity and conciseness
- Maintaining consistent terminology across docs
Great technical writing starts with a solid foundation. In this section we'll explore three fundamental principles that apply to every piece of documentation you create.
1. Know Your Audience
Understanding your readers is fundamental to effective technical writing:
- Identify User Personas: Define who will use your documentation (developers, end-users, administrators)
- Assess Technical Level: Match complexity to audience expertise
- Consider Context: Where and how will they access your docs?
- Language Preferences: Account for international audiences and localization needs
2. Clarity and Conciseness
Write content that's easy to understand and quick to consume:
Do's:
- Use active voice: "Click the button" (not "The button should be clicked")
- Keep sentences under 25 words when possible
- Use simple words: "use" instead of "utilize"
- Break complex ideas into smaller chunks
Don'ts:
- Avoid unnecessary jargon and buzzwords
- Don't use passive constructions excessively
- Eliminate redundant phrases ("in order to" → "to")
- Skip filler words ("actually", "basically", "really")
3. Consistent Terminology
Maintain consistency throughout your documentation:
- Create and follow a terminology glossary
- Use the same term for the same concept (e.g., don't alternate between "user" and "customer")
- Define acronyms on first use
- Follow industry-standard naming conventions