* . *
  • About
  • Advertise
  • Privacy & Policy
  • Contact
Thursday, July 3, 2025
Earth-News
  • Home
  • Business
  • Entertainment
    Neil Young Plays Rare Full-Band ‘Ambulance Blues’ With The Chrome Hearts – Yahoo

    Neil Young Stuns Fans with Rare Full-Band Performance of ‘Ambulance Blues’ Alongside The Chrome Hearts

    BTS Announce Their Big Return and Yes, They Already Have Some Major Plans in the Works – Yahoo

    BTS Announce Their Big Return and Yes, They Already Have Some Major Plans in the Works – Yahoo

    Nantucket Dance Festival opens July 8 – The Inquirer and Mirror

    Nantucket Dance Festival Launches with Thrilling Performances Beginning July 8

    A Secret Society, Ritualistic Killings, and a Century-Old Curse Netflix and YRF Entertainment’s ‘Mandala Murders’ Premieres July 25 – About Netflix

    A Secret Society, Ritualistic Killings, and a Century-Old Curse: Dive into the Chilling World of ‘Mandala Murders’ Premiering July 25

    Susquehanna Raises Penn Entertainment Inc. (PENN) Price Target. – Yahoo Finance

    Susquehanna Raises Price Target for Penn Entertainment Inc. (PENN)

    George Lopez is coming to Spokane – KXLY.com

    George Lopez is coming to Spokane – KXLY.com

  • 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
    LG Innotek CEO Moon Hyuksoo: “Our Next-gen Substrate Technology Will Change the Industry Paradigm” – TechPowerUp

    LG Innotek CEO Moon Hyuksoo: “Our Next-Gen Substrate Technology Will Revolutionize the Industry” Revolutionizing the Future: LG Innotek’s CEO Unveils Game-Changing Next-Gen Substrate Technology

    Inspira Technologies Secures Landmark $22.5M Deal: Major Revenue Breakthrough After FDA Clearance – Stock Titan

    Inspira Technologies Secures Landmark $22.5M Deal: Major Revenue Breakthrough After FDA Clearance – Stock Titan

    Meiwu Technology Company Limited and Shenzhen Zhinuo – GlobeNewswire

    Meiwu Technology Company Limited and Shenzhen Zhinuo – GlobeNewswire

    Owls inspire new revolutionary noise reduction technology – KTEN

    Owls inspire new revolutionary noise reduction technology – KTEN

    New center coming to Mizzou will focus on energy research and technology – Columbia Missourian

    Mizzou Launches Innovative New Center Dedicated to Energy Research and Technology

    Mirrors in space and underwater curtains: can technology buy us enough time to save the Arctic ice caps? – The Guardian

    Can Technology Like Space Mirrors and Underwater Curtains Buy Us Time to Save the Arctic Ice Caps?

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
  • Home
  • Business
  • Entertainment
    Neil Young Plays Rare Full-Band ‘Ambulance Blues’ With The Chrome Hearts – Yahoo

    Neil Young Stuns Fans with Rare Full-Band Performance of ‘Ambulance Blues’ Alongside The Chrome Hearts

    BTS Announce Their Big Return and Yes, They Already Have Some Major Plans in the Works – Yahoo

    BTS Announce Their Big Return and Yes, They Already Have Some Major Plans in the Works – Yahoo

    Nantucket Dance Festival opens July 8 – The Inquirer and Mirror

    Nantucket Dance Festival Launches with Thrilling Performances Beginning July 8

    A Secret Society, Ritualistic Killings, and a Century-Old Curse Netflix and YRF Entertainment’s ‘Mandala Murders’ Premieres July 25 – About Netflix

    A Secret Society, Ritualistic Killings, and a Century-Old Curse: Dive into the Chilling World of ‘Mandala Murders’ Premiering July 25

    Susquehanna Raises Penn Entertainment Inc. (PENN) Price Target. – Yahoo Finance

    Susquehanna Raises Price Target for Penn Entertainment Inc. (PENN)

    George Lopez is coming to Spokane – KXLY.com

    George Lopez is coming to Spokane – KXLY.com

  • 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
    LG Innotek CEO Moon Hyuksoo: “Our Next-gen Substrate Technology Will Change the Industry Paradigm” – TechPowerUp

    LG Innotek CEO Moon Hyuksoo: “Our Next-Gen Substrate Technology Will Revolutionize the Industry” Revolutionizing the Future: LG Innotek’s CEO Unveils Game-Changing Next-Gen Substrate Technology

    Inspira Technologies Secures Landmark $22.5M Deal: Major Revenue Breakthrough After FDA Clearance – Stock Titan

    Inspira Technologies Secures Landmark $22.5M Deal: Major Revenue Breakthrough After FDA Clearance – Stock Titan

    Meiwu Technology Company Limited and Shenzhen Zhinuo – GlobeNewswire

    Meiwu Technology Company Limited and Shenzhen Zhinuo – GlobeNewswire

    Owls inspire new revolutionary noise reduction technology – KTEN

    Owls inspire new revolutionary noise reduction technology – KTEN

    New center coming to Mizzou will focus on energy research and technology – Columbia Missourian

    Mizzou Launches Innovative New Center Dedicated to Energy Research and Technology

    Mirrors in space and underwater curtains: can technology buy us enough time to save the Arctic ice caps? – The Guardian

    Can Technology Like Space Mirrors and Underwater Curtains Buy Us Time to Save the Arctic Ice Caps?

    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#

LG Innotek CEO Moon Hyuksoo: “Our Next-gen Substrate Technology Will Change the Industry Paradigm” – TechPowerUp

LG Innotek CEO Moon Hyuksoo: “Our Next-Gen Substrate Technology Will Revolutionize the Industry” Revolutionizing the Future: LG Innotek’s CEO Unveils Game-Changing Next-Gen Substrate Technology

July 3, 2025
Diego Luna strikes shaky USMNT to win over Guatemala, and into Gold Cup final – Yahoo Sports

Diego Luna Propels USMNT to Thrilling Win Over Guatemala, Punching Ticket to Gold Cup Final

July 3, 2025
Multiple hunting displays in wild broadclub cuttlefish – How – 2025 – Ecology – ESA Journals

Mind-Blowing Hunting Tactics Uncovered in Wild Broadclub Cuttlefish

July 3, 2025
The Catholic Church believes in science. That good Christians must be anti-science is a myth. – National Catholic Reporter

How the Catholic Church Embraces Science: Debunking the Myth That Faith and Facts Clash

July 3, 2025
Making Europe a global leader in life sciences – European Commission

Unlocking Europe’s Potential: How to Become a Global Leader in Life Sciences

July 3, 2025
Solenn Heussaff is the cover star of a local lifestyle magazine – GMA Network

Solenn Heussaff is the cover star of a local lifestyle magazine – GMA Network

July 3, 2025
NWSL to take June break for ’26 men’s World Cup – ESPN

NWSL to Pause Season in June Ahead of 2026 Men’s World Cup Excitement

July 3, 2025
Russia’s economy just flashed warning signs about manufacturing and employment – Business Insider

Russia’s Economy Sends Alarming Signals in Manufacturing and Employment

July 3, 2025
Neil Young Plays Rare Full-Band ‘Ambulance Blues’ With The Chrome Hearts – Yahoo

Neil Young Stuns Fans with Rare Full-Band Performance of ‘Ambulance Blues’ Alongside The Chrome Hearts

July 3, 2025
Registered nurse explains reasoning for health care workers strike against WellSpan Health – WGAL

Registered nurse explains reasoning for health care workers strike against WellSpan Health – WGAL

July 3, 2025

Categories

Archives

July 2025
MTWTFSS
 123456
78910111213
14151617181920
21222324252627
28293031 
« Jun    
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 (703)
  • Economy (729)
  • Entertainment (21,617)
  • General (15,692)
  • Health (9,768)
  • Lifestyle (733)
  • News (22,149)
  • People (729)
  • Politics (736)
  • Science (15,947)
  • Sports (21,227)
  • Technology (15,713)
  • World (709)

Recent News

LG Innotek CEO Moon Hyuksoo: “Our Next-gen Substrate Technology Will Change the Industry Paradigm” – TechPowerUp

LG Innotek CEO Moon Hyuksoo: “Our Next-Gen Substrate Technology Will Revolutionize the Industry” Revolutionizing the Future: LG Innotek’s CEO Unveils Game-Changing Next-Gen Substrate Technology

July 3, 2025
Diego Luna strikes shaky USMNT to win over Guatemala, and into Gold Cup final – Yahoo Sports

Diego Luna Propels USMNT to Thrilling Win Over Guatemala, Punching Ticket to Gold Cup Final

July 3, 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