Click here to Skip to main content
15,884,425 members

The Insider News

   

The Insider News is for breaking IT and Software development news. Post your news, your alerts and your inside scoops. This is an IT news-only forum - all off-topic, non-news posts will be removed. If you wish to ask a programming question please post it here.

Get The Daily Insider direct to your mailbox every day. Subscribe now!

 
NewsHow an obscure British PC maker invented ARM and changed the world Pin
Kent Sharkey22-Dec-20 11:16
staffKent Sharkey22-Dec-20 11:16 
GeneralRe: How an obscure British PC maker invented ARM and changed the world Pin
markrlondon22-Dec-20 12:19
markrlondon22-Dec-20 12:19 
GeneralRe: How an obscure British PC maker invented ARM and changed the world Pin
Kent Sharkey22-Dec-20 12:45
staffKent Sharkey22-Dec-20 12:45 
GeneralRe: How an obscure British PC maker invented ARM and changed the world Pin
markrlondon23-Dec-20 4:45
markrlondon23-Dec-20 4:45 
NewsHow Claude Shannon invented the future Pin
Kent Sharkey22-Dec-20 11:16
staffKent Sharkey22-Dec-20 11:16 
NewsWriting is the most important new skill for tech workers. Here’s how to build it Pin
Kent Sharkey22-Dec-20 10:01
staffKent Sharkey22-Dec-20 10:01 
GeneralRe: Writing is the most important new skill for tech workers. Here’s how to build it Pin
jeron122-Dec-20 10:28
jeron122-Dec-20 10:28 
RantRe: Writing is the most important new skill for tech workers. Here’s how to build it PinPopular
Gary R. Wheeler23-Dec-20 4:13
Gary R. Wheeler23-Dec-20 4:13 
... and there's the problem.

I'm an old fart, so I'm going to subject you to a story; shut up and listen, because that's the point here.

When I was in college I worked for a small consulting company. Most of the time I was writing bits of code on larger projects, thoroughly supervised by more experienced engineers. One project was different, however. A customer needed a document that would describe their computing resources (several VAXen, peripherals, data base systems, and so on) to their potential users. I got the job.

Like most engineers I loathed writing. Why express in words what you were going to do in code, or in this case, what the machines could do? Over the course of six months I wrote a 70 page document describing each of the four VAX machines, the peripherals they had, what software they were running, and so on. Pretty dry stuff, until the people in the organization who were reviewing drafts started asking questions. "Why is it like that? Why does this machine have this feature, and it's not on that machine?" and so on. This is where I learned how to write.

The first rule of writing isn't about spelling, or grammar, or what bloody font you use. It's this: CONSIDER YOUR AUDIENCE! The document you're writing has a purpose, otherwise why write it? Your job as author is to correlate that purpose to the needs, skills, and temperment of your audience. The thing that my audience reviewing my drafts pointed out was that while the basic information was useful, they also wanted to know the rationale behind the configuration. That knowledge, not available anywhere except in the system manager's heads, was important to the users making decisions. I finally realized that the purpose of this document was to help these folks decide if and how to use this organization's resources. My audience was technically-oriented but not necessarily technically proficient to understand the implications in the dry inventories that were the document's start.

The end result of this half-year stint as a technical writer has had a more profound affect on my career than any other part of my education or early experience. I no longer hate writing. When I need to do it, I can create appropriate readable and useful documentation quickly. Most of the suggested changes I get on my documentation are based on business concerns of which I wasn't aware, and even those have faded somewhat over time as I have matured.

The contempt the engineers of my generation felt for writing as a skill has been replaced by apathy and indifference today. With email, IM, text messages, social media, and so on, all of you write... a lot. The problem is the writing is ephemeral and you take the view that the quality of it doesn't matter, only the speed with which you respond is important. You can see evidence of this here on CP. Over time the writing quality in the articles has shown a steady decline. In many of them the text is only a delimiter for links to the code and sample executable. Even in cases where there is a fair amount of text in the article, it's poorly organized and doesn't express itself clearly. I'm not faulting the CP editors here, by the way. They have a thankless task just ensuring that links work and that article submissions aren't camouflaged political screeds.

The realization expressed in this Insider article is simple: maybe there is something important after all about the way we express ourselves in written text.
Software Zen: delete this;

GeneralRe: Writing is the most important new skill for tech workers. Here’s how to build it Pin
Nelek23-Dec-20 4:28
protectorNelek23-Dec-20 4:28 
GeneralRe: Writing is the most important new skill for tech workers. Here’s how to build it Pin
Kent Sharkey23-Dec-20 4:41
staffKent Sharkey23-Dec-20 4:41 
NewsCan we be manipulated into sharing private info online? Yes, says study Pin
Kent Sharkey22-Dec-20 10:01
staffKent Sharkey22-Dec-20 10:01 
GeneralRe: Can we be manipulated into sharing private info online? Yes, says study Pin
Nelek22-Dec-20 22:50
protectorNelek22-Dec-20 22:50 
GeneralRe: Can we be manipulated into sharing private info online? Yes, says study Pin
Joe Woodbury23-Dec-20 8:47
professionalJoe Woodbury23-Dec-20 8:47 
GeneralRe: Can we be manipulated into sharing private info online? Yes, says study Pin
Kent Sharkey23-Dec-20 8:57
staffKent Sharkey23-Dec-20 8:57 
NewsOctopuses observed punching fish, perhaps out of spite, scientists say Pin
Kent Sharkey22-Dec-20 9:16
staffKent Sharkey22-Dec-20 9:16 
News.NET 5.0 now available for Red Hat Enterprise Linux and Red Hat OpenShift Pin
Kent Sharkey22-Dec-20 7:16
staffKent Sharkey22-Dec-20 7:16 
GeneralRe: .NET 5.0 now available for Red Hat Enterprise Linux and Red Hat OpenShift Pin
Nelek22-Dec-20 9:32
protectorNelek22-Dec-20 9:32 
NewsGoogle and Facebook reportedly agreed to help each other against potential antitrust action Pin
Kent Sharkey22-Dec-20 7:16
staffKent Sharkey22-Dec-20 7:16 
GeneralRe: Google and Facebook reportedly agreed to help each other against potential antitrust action Pin
Nelek22-Dec-20 9:11
protectorNelek22-Dec-20 9:11 
NewsMicrosoft, McAfee and 17 other entities unite to form Ransomware Task Force Pin
Kent Sharkey22-Dec-20 7:16
staffKent Sharkey22-Dec-20 7:16 
GeneralRe: Microsoft, McAfee and 17 other entities unite to form Ransomware Task Force Pin
Joe Woodbury22-Dec-20 9:53
professionalJoe Woodbury22-Dec-20 9:53 
NewsExclusive: Apple targets car production by 2024 and eyes 'next level' battery technology Pin
Kent Sharkey21-Dec-20 11:16
staffKent Sharkey21-Dec-20 11:16 
JokeRe: Exclusive: Apple targets car production by 2024 and eyes 'next level' battery technology Pin
Randor 21-Dec-20 14:42
professional Randor 21-Dec-20 14:42 
GeneralRe: Exclusive: Apple targets car production by 2024 and eyes 'next level' battery technology Pin
abmv21-Dec-20 18:05
professionalabmv21-Dec-20 18:05 
GeneralRe: Exclusive: Apple targets car production by 2024 and eyes 'next level' battery technology Pin
Marc Clifton22-Dec-20 0:53
mvaMarc Clifton22-Dec-20 0:53 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.