* . *
  • About
  • Advertise
  • Privacy & Policy
  • Contact
Thursday, October 23, 2025
Earth-News
  • Home
  • Business
  • Entertainment
    Reba McEntire Details Personal Relationship With Late Stepson Brandon Blackstock – KNDU

    Reba McEntire Shares Emotional Tribute to Her Late Stepson Brandon Blackstock

    Sacramento city leaders approve adding 2 entertainment zones in midtown – CBS News

    Sacramento City Leaders Approve Two Thrilling New Entertainment Zones in Midtown

    AMC brings first new Dolby Experience to Gwinnett since 2017 – Wyoming News Now

    AMC Launches First New Dolby Experience in Gwinnett Since 2017

    Hetzel Design: blending architecture and entertainment – Blooloop

    Hetzel Design: Where Architecture and Entertainment Unite in Perfect Harmony

    Country music legend rushed to hospital year after heart surgery. Here’s what we know – PennLive.com

    Country Music Legend Rushed to Hospital One Year After Heart Surgery – What’s Happening Now?

    Strictly Come Dancing results: Chris Robshaw is eliminated while drag queen La Voix escapes dance-off – Yahoo

    Strictly Come Dancing results: Chris Robshaw is eliminated while drag queen La Voix escapes dance-off – Yahoo

  • General
  • Health
  • News

    Cracking the Code: Why China’s Economic Challenges Aren’t Shaking Markets, Unlike America’s” – Bloomberg

    Trump’s Narrow Window to Spread the Truth About Harris

    Trump’s Narrow Window to Spread the Truth About Harris

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Trending Tags

    • Trump Inauguration
    • United Stated
    • White House
    • Market Stories
    • Election Results
  • Science
  • Sports
  • Technology
    Rydberg Technologies Inc. Announces Launch of Rydberg Photonics in Berlin – The Quantum Insider

    Rydberg Technologies Launches Exciting New Photonics Division in Berlin

    A look into new technology at Columbia University that could help prevent a dangerous pregnancy complication – ABC7 New York

    A look into new technology at Columbia University that could help prevent a dangerous pregnancy complication – ABC7 New York

    Office Technology: Dealers’ Managed IT Revenue up Nearly 30% – The Cannata Report –

    Office Technology: Dealers’ Managed IT Revenue up Nearly 30% – The Cannata Report –

    3 E Network Technology Group Limited Closes $1.5 Million Convertible Promissory Note Offering – Quiver Quantitative

    3 E Network Technology Group Limited Closes $1.5 Million Convertible Promissory Note Offering – Quiver Quantitative

    3 Technology Stocks to Buy Now – Yahoo Finance

    3 Must-Buy Tech Stocks You Can’t Afford to Miss Right Now

    ‘New frontier’: Austin leaders start discussions on air taxi technology – KXAN Austin

    Austin Leaders Ignite Exciting Conversations on the Future of Air Taxi Technology

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
  • Home
  • Business
  • Entertainment
    Reba McEntire Details Personal Relationship With Late Stepson Brandon Blackstock – KNDU

    Reba McEntire Shares Emotional Tribute to Her Late Stepson Brandon Blackstock

    Sacramento city leaders approve adding 2 entertainment zones in midtown – CBS News

    Sacramento City Leaders Approve Two Thrilling New Entertainment Zones in Midtown

    AMC brings first new Dolby Experience to Gwinnett since 2017 – Wyoming News Now

    AMC Launches First New Dolby Experience in Gwinnett Since 2017

    Hetzel Design: blending architecture and entertainment – Blooloop

    Hetzel Design: Where Architecture and Entertainment Unite in Perfect Harmony

    Country music legend rushed to hospital year after heart surgery. Here’s what we know – PennLive.com

    Country Music Legend Rushed to Hospital One Year After Heart Surgery – What’s Happening Now?

    Strictly Come Dancing results: Chris Robshaw is eliminated while drag queen La Voix escapes dance-off – Yahoo

    Strictly Come Dancing results: Chris Robshaw is eliminated while drag queen La Voix escapes dance-off – Yahoo

  • General
  • Health
  • News

    Cracking the Code: Why China’s Economic Challenges Aren’t Shaking Markets, Unlike America’s” – Bloomberg

    Trump’s Narrow Window to Spread the Truth About Harris

    Trump’s Narrow Window to Spread the Truth About Harris

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Trending Tags

    • Trump Inauguration
    • United Stated
    • White House
    • Market Stories
    • Election Results
  • Science
  • Sports
  • Technology
    Rydberg Technologies Inc. Announces Launch of Rydberg Photonics in Berlin – The Quantum Insider

    Rydberg Technologies Launches Exciting New Photonics Division in Berlin

    A look into new technology at Columbia University that could help prevent a dangerous pregnancy complication – ABC7 New York

    A look into new technology at Columbia University that could help prevent a dangerous pregnancy complication – ABC7 New York

    Office Technology: Dealers’ Managed IT Revenue up Nearly 30% – The Cannata Report –

    Office Technology: Dealers’ Managed IT Revenue up Nearly 30% – The Cannata Report –

    3 E Network Technology Group Limited Closes $1.5 Million Convertible Promissory Note Offering – Quiver Quantitative

    3 E Network Technology Group Limited Closes $1.5 Million Convertible Promissory Note Offering – Quiver Quantitative

    3 Technology Stocks to Buy Now – Yahoo Finance

    3 Must-Buy Tech Stocks You Can’t Afford to Miss Right Now

    ‘New frontier’: Austin leaders start discussions on air taxi technology – KXAN Austin

    Austin Leaders Ignite Exciting Conversations on the Future of Air Taxi Technology

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
Earth-News
No Result
View All Result
Home Technology

Advent of Technical Writing: Style

December 9, 2023
in Technology
Advent of Technical Writing: Style
Share on FacebookShare on Twitter

Published on
December 09, 2023
under the Advent of Technical Writing (Series) category.Toggle Memex mode

This is the ninth post in the Advent of Technical Writing series, wherein I will share something I have learned from my experience as a technical writer. My experience is primarily in software technical writing, but what you read may apply to different fields, too. View all posts in the series.

Taylor Swift’s song Style, part of her 1989 album, echoes in my head as I start writing this post.

That is style (on more levels than one!).

Technical writing involves a lot of regiment. Many organisations have style guides that document how you should write. Content should be consistent. But, there is still significant room for creativity. We often call this “style.” Style is how you write. The way that you express, explain, structure. The way that you turn an idea from a light bulb above your head (metaphorically), to a finished piece.

Growing into style

Throughout my professional technical writing, there have been varying degrees to which I can apply a style. When I wrote content for beginners who were learning Python, I liked to use coffee shops as examples. To explain data structures, what standard library functions did, and more. I did this because I liked coffee. This was part of my style. I also learned the importance of balance between direct language that fosters understanding and bluntness. I welcome introducing a bit of playfulness into my writing.

In my current role, which involves documenting open source software, writing technical guides, marketing materials, and more, my style comes out in different ways. The way I often end introductions with text like “Without further ado, let’s get started!” or in the way that I include a visual example of what a reader will accomplish by the end of a guide before the end of an introduction.

Don’t worry about finding your own style; you will grow into one as you explore. I have found writing different types of content helpful in building my style. Writing personal content on this blog has been helpful, too. The more types of writing to which you are exposed — both through reading and writing — the more you will get to know how you prefer to communicate.

In writing, these is a place for directness, conciseness, whimsy, visual examples, introducing additional context that you found fascinating while researching a topic, and more. You get to decide how you communicate concepts.

How do you find style? Read, write, get feedback, and keep going. Don’t worry about finding a style. You will grow into one over time. You will find yourself using certain words and phrases over again. You will find that you structure your work in certain ways. The feedback you receive will help inform how you write.

The goal of style is not to be distinct so much as it is to use your unique abilty to express concepts in ways that people can understand best.

Style outside of professional writing

Indeed, whimsy and humour, while not appropriate for many professional tasks, can go a long way in personal writing. For example, I just came across a blog post on convolutions, a mathematical concept with applications in machine learning, that started like this:

Like making engineering students squirm? Have them explain convolution and (if you’re barbarous) the convolution theorem. They’ll mutter something about sliding windows as they try to escape through one.

Here, the author has taken a more informal tone than most writing I have read on machine learning. The author decided that these words would be effective as a hook to introduce their piece. The author then goes on to say:

Yikes. Let’s start without calculus: Convolution is fancy multiplication.

While “fancy” might not fit in an academic paper, it fits in well in this explainer. When you introduce complex technical topics to a new audience in educational material, informal language can go a long way to make your content more relatable and less dry. The extent to which you use this opportunity? That is style.

Written by human, not by AI

Other posts in this series

Check out the other posts I have written as part of this series.

Responses

Comment on this post

Respond to this post by sending a Webmention.

Have a comment? Email me at [email protected].

>>> Read full article>>>
Copyright for syndicated content belongs to the linked Source : Hacker News – https://jamesg.blog/2023/12/09/style/

Tags: adventtechnicaltechnology
Previous Post

Deadweight Loss as a Service

Next Post

Murder is a pixel art ECS game engine in C#

UIPM 2025 Obstacle World Championships (OCR): All you need to know – Union Internationale de Pentathlon Moderne (UIPM)

Everything You Need to Know About the 2025 Obstacle World Championships (OCR)

October 23, 2025
PPPs in Bolivia: The future of our economy? – Dentons

Could PPPs Unlock Bolivia’s Path to Economic Prosperity?

October 23, 2025
Reba McEntire Details Personal Relationship With Late Stepson Brandon Blackstock – KNDU

Reba McEntire Shares Emotional Tribute to Her Late Stepson Brandon Blackstock

October 23, 2025
Mark Peterson receives inaugural APSA Career Achievement Award in Health Politics and Policy – UCLA

Mark Peterson receives inaugural APSA Career Achievement Award in Health Politics and Policy – UCLA

October 23, 2025
GOP senator accuses Dems of playing politics with people’s lives: ‘This is a crime’ – Fox Business

GOP Senator Slams Democrats for Playing Politics with People’s Lives: ‘This Is a Crime

October 23, 2025
Forest cover enhances pest control by birds and bats independently of vineyard management intensity – besjournals

Forest cover enhances pest control by birds and bats independently of vineyard management intensity – besjournals

October 22, 2025
November Family Consumer Science Program – Alachua County

November Family Consumer Science Program – Alachua County

October 22, 2025
Correction: Anti-Science Movement story – The News-Gazette

Unraveling the Truth Behind the Anti-Science Movement: A Closer Look

October 22, 2025
Best Burgers 2025: 9 cult-favorite burgers off the beaten path – Yahoo

Best Burgers 2025: 9 cult-favorite burgers off the beaten path – Yahoo

October 22, 2025
Rydberg Technologies Inc. Announces Launch of Rydberg Photonics in Berlin – The Quantum Insider

Rydberg Technologies Launches Exciting New Photonics Division in Berlin

October 22, 2025

Categories

Archives

October 2025
M T W T F S S
 12345
6789101112
13141516171819
20212223242526
2728293031  
« Sep    
Earth-News.info

The Earth News is an independent English-language daily published Website from all around the World News

Browse by Category

  • Business (20,132)
  • Ecology (881)
  • Economy (903)
  • Entertainment (21,774)
  • General (17,751)
  • Health (9,944)
  • Lifestyle (915)
  • News (22,149)
  • People (903)
  • Politics (913)
  • Science (16,113)
  • Sports (21,402)
  • Technology (15,882)
  • World (886)

Recent News

UIPM 2025 Obstacle World Championships (OCR): All you need to know – Union Internationale de Pentathlon Moderne (UIPM)

Everything You Need to Know About the 2025 Obstacle World Championships (OCR)

October 23, 2025
PPPs in Bolivia: The future of our economy? – Dentons

Could PPPs Unlock Bolivia’s Path to Economic Prosperity?

October 23, 2025
  • About
  • Advertise
  • Privacy & Policy
  • Contact

© 2023 earth-news.info

No Result
View All Result

© 2023 earth-news.info

No Result
View All Result

© 2023 earth-news.info

Go to mobile version