How to Describe Difficult Technical Concepts

technical-concepts

Rule #1!

You can’t describe what you don’t understand.

We agree?

You can try and fudge it, but the people reviewing the document will see through it.

I will. You would.

Maybe you can try and cheat by cobbling together material that others have written, but it doesn’t work.

Anyway, that’s not writing. It’s just camouflaging what others have written and trying to pass it off as your own material. We can do better than that, right?

How to understand and write technical concepts

As a business or technical writer, you’ll often have to describe difficult, technical concepts to your readers.

How can you develop enough understanding of the concept to write about it with confidence?

Let’s take it one step at a time.

#1. Research the topic in depth.

Look on the wiki, in the pdfs, in the business analyst’s pages, and in training pages. The more information you can gather, the better placed you are to ask more informed questions.

Learning is incremental. Expose yourself to the business, technical, and software sides of the application. By degrees, these will begin to ‘gel’ and start to make more sense.

#2. Look at it from different angles

See where the issue can originate. The issue could be in different places.

  • How can you develop a better understanding of the subject?
  • What caused the issue to occur?
  • What contributing factors were involved?
  • Did it occur only under specific circumstances?

Looking at the issue from different angles helps you identify any underlying information that may not have been obvious at first.

#3. Discuss it with others

See if DEV, QA, and BAs have others way to look at this.

Can they give you an insight you haven’t already thought of? Again, your aim is to develop a more nuanced view of the topic.

Discussions with others, in particular if you use open ended questions that prompt or evoke more dialogue, will help unearth nuggets of information you may have overlooked.

#4. Let it ‘rest’ mentally

Leave the topic alone for a while. Giving yourself distance from the problem helps you gain perspective.

Transcribe what you understand.

When I read something, I can tell if the person knows what they’re writing about (or not) almost immediately. It comes from years of reviewing, writing, and re-writing.

Before you try to document very thorny technical subjects, make sure you understand it first. Once you understand it, you can write it.

One last thing.

Understanding grows. Keep chipping away. Eventually, it’ll click!

PSHow to Think Clearly: A Guide to Critical Thinking

Thousands of templates to jump start your project

Acceptance Test Plan

Contingency Plan

Software Development Templates

Acquisition Plan

Conversion Plan

Software Requirements Specification

Action Plan

Cost Benefit Analysis

Software Testing

API Documentation

Database Design

Standard Operating Procedures (SOP)

Audience Analysis

Datasheet

Statement of Work

Availability Plan

Deployment Plan

System Administration Guide

Bill of Materials

Design Document

System Boundary

Business Case

Disaster Recovery Plan

System Design Document

Business Continuity

Disposition Plan

System Specifications

Business Plan

Documentation Plan

Technical Writing Templates

Business Process

Employee Handbook

Test Plan

Business Requirements

Error Message Guide

Training Plan

Business Rules

Expression of Interest

Transition Plan

Capacity Plan

Fact Sheet

Troubleshooting Guide

Case Study

Feasibility Study

Use Case

Change Management Plan

Functional Requirements

User Guide

Communication Plan

Grant Proposal

Verification and Validation Plan

Concept of Operations

Implementation Plan

White Papers

Concept Proposal

Installation Plan

Work Instructions

Configuration Management Plan

Interface Control Document

Software Development Templates

Acceptance Test Plan

Maintenance Plan

Software Requirements Specification

Acquisition Plan

Market Research

Software Testing

Action Plan

Marketing Plan

Standard Operating Procedures (SOP)

API Documentation

Needs Statement

Statement of Work

Audience Analysis

Operations Guide

System Administration Guide

Availability Plan

Policy Manual

System Boundary

Bill of Materials

Project Plan

System Design Document

Business Case

Proposal Manager Templates

System Specifications

Business Continuity

Proposal Template

Technical Writing Templates

Business Plan

Quality Assurance Plan

Test Plan

Business Process

Release Notes

Training Plan

Business Requirements

Request for Proposal

Transition Plan

Business Rules

Risk Management Plan

Troubleshooting Guide

Capacity Plan

Scope of Work

Use Case

Case Study

Security Plan

User Guide

Change Management Plan

Service Level Agreement (SLA)

Verification and Validation Plan

Communication Plan

Setup Guide

White Papers

Concept of Operations

Social Media Policy

Work Instructions

Concept Proposal

Contingency Plan

 

Configuration Management Plan

Conversion Plan