The 10 Commandments of Technical Writing

Technical writing is all about creating documents that people can actually use and understand.

It’s not just about writing down facts.

It’s about making sure your audience gets the information they need in a way that’s clear and practical.

Here are the 10 commandments of technical writing to help you create content that stands out and gets the job done.


1. Thou shalt know thy audience

Before you write a single word, think about who you’re writing for.

Is it someone with a technical background or a complete beginner?

Your tone, level of detail, and choice of words all depend on your audience.

If you don’t know your audience, your content won’t land right.


2. Thou shalt be clear and concise

Don’t make people work hard to understand your writing.

Use short sentences, simple words, and get to the point quickly.

If something can be said in fewer words, say it that way.

Nobody enjoys reading overly complicated text.


3. Thou shalt structure thy content

Nobody wants to read a wall of text.

Use headings, subheadings, bullet points, and numbered lists to break things up.

Make it easy for readers to scan your document and find what they need.

Good structure isn’t just helpful—it’s necessary.


4. Thou shalt use visuals wisely

A good diagram, chart, or flowchart can explain things much better than paragraphs of text.

Visuals help people grasp complex concepts faster.

But don’t overdo it.

Too many images or cluttered graphics can overwhelm your readers.


5. Thou shalt be consistent

Consistency makes your content easier to read and more professional.

Use the same fonts, colours, formatting, and terms throughout the document.

If you call something a “feature” in one section, don’t call it a “function” in another.


6. Thou shalt test thy instructions

If you’re writing instructions or procedures, always test them yourself.

Better yet, get someone else to follow them and see if they can complete the task.

This is the best way to catch errors or steps you might have missed.


7. Thou shalt avoid jargon

Unless your audience is very technical, avoid using jargon or overly technical terms.

If you must use specialised language, make sure you explain it clearly.

The goal is to make your content accessible, not confusing.


8. Thou shalt proofread religiously

Typos and grammar mistakes can ruin the credibility of your work.

Always proofread your document before sending it out.

Better yet, get a fresh pair of eyes to review it for you.

Mistakes are easy to miss when you’ve been staring at the same document for hours.


9. Thou shalt focus on usability

Your document isn’t just about looking good.

It’s about being useful.

Think about what your audience needs to do with the information.

Are they trying to troubleshoot something? Follow a procedure? Make sure your content helps them achieve their goal.


10. Thou shalt keep learning

Technical writing is always evolving.

New tools, trends, and best practices pop up all the time.

Stay curious and keep learning.

The more you know, the better your content will be.


Takeaway

Good technical writing isn’t just about putting words on a page.

It’s about creating content that’s clear, usable, and helpful for the people who need it.

Follow these 10 commandments, and you’ll create documents that stand out for all the right reasons.

Whether you’re writing a user guide, a procedure, or a technical report, these principles will help you deliver work that’s both professional and practical.

Keep things simple, focus on your audience, and never stop improving. That’s the real key to great technical writing.

Read More

Related Posts

Stakeholders working together on a BPMN 2.0 process map

BPMN 2.0 Process Mapping Best Practices With Stakeholders

BPMN 2.0 is one of the clearest ways to represent how work actually happens.It creates a shared language across business and technical teams.It reduces ambiguity and helps organisations see their processes end to end. But BPMN 2.0 only works well when the right information is captured.That information does not live

📘 How Capturing Knowledge Keeps Business as Usual

Every business relies on people to keep things moving. But when knowledge only lives in people’s heads, continuity is fragile. Staff take leave, change roles or leave the company altogether. Without a system to capture what they know, Business as Usual (BAU) slows down—or even stops. A knowledge base prevents

💸 The Cost of Not Capturing Knowledge from Key People

Every organisation has people who carry knowledge that keeps the business running. It could be the senior manager who remembers why a process exists. It could be the technician who knows the workaround when systems fail. Or it could be the administrator who understands the unspoken rules that hold a

📘 How to Build a Good Knowledge Base Through Collaboration

A knowledge base is one of the most valuable tools a business can have. It saves time, reduces errors and keeps knowledge inside the organisation. But building a good knowledge base isn’t just about choosing the right software. It’s about working with people, drawing out their knowledge and turning it