* . *
  • About
  • Advertise
  • Privacy & Policy
  • Contact
Thursday, July 24, 2025
Earth-News
  • Home
  • Business
  • Entertainment
    Black Box Players presents ‘The Three Musketeers’ – CBS 19 News

    Experience the Adventure: Black Box Players Bring ‘The Three Musketeers’ to Life!

    AP Entertainment SummaryBrief at 1:51 p.m. EDT – Channel 3000

    Entertainment Highlights: Key Updates You Can’t Miss

    ‘Devil Wears Prada 2’ casts Anne Hathaway’s love interest replacing Adrian Grenier’s Nate – Entertainment Weekly

    Devil Wears Prada 2′ Casts New Love Interest for Anne Hathaway, Replacing Adrian Grenier’s Nate

    12 ‘Late Show’ Moments Proving Stephen Colbert Can’t Be Replaced – The Mountaineer

    12 Unforgettable ‘Late Show’ Moments That Prove Stephen Colbert Is Truly One of a Kind

    Canes owner Tom Dundon’s real estate firm eyes entertainment complex near RDU – The Business Journals

    Canes Owner Tom Dundon’s Real Estate Firm Unveils Plans for Thrilling New Entertainment Complex Near RDU

    Inspired Entertainment, Inc.’s (NASDAQ:INSE) Price Is Right But Growth Is Lacking After Shares Rocket 29% – simplywall.st

    Inspired Entertainment Soars 29% but Growth Momentum Falls Short

  • 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
    Behind the Screens: The Impact of Technology on Real Estate – TRREB

    Behind the Screens: How Technology is Transforming the Future of Real Estate

    Sustainserv and Palau Announce Technology Partnership to Leverage Innovative AI Platform to Advance Sustainability Reporting – Business Wire

    Sustainserv and Palau Team Up to Transform Sustainability Reporting with Breakthrough AI Technology

    Morgan Adamski Joins PwC in Newly Created Cyber, Data & Technology Risk Division – HSToday

    Morgan Adamski Leads the Charge in PwC’s Cutting-Edge Cyber, Data & Technology Risk Division

    Transformative technology, support for food entrepreneurs spotlighted – University of Hawaii System

    How Cutting-Edge Technology and Strong Support Are Revolutionizing Food Entrepreneurs’ Success

    Cold Weather Alloy Opens New Possibilities for Space Technology – Universe Today

    Revolutionary Cold Weather Alloy Unlocks New Frontiers in Space Technology

    Defence Holdings PLC Transitions from Esports to Pioneering Defence Technology

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
  • Home
  • Business
  • Entertainment
    Black Box Players presents ‘The Three Musketeers’ – CBS 19 News

    Experience the Adventure: Black Box Players Bring ‘The Three Musketeers’ to Life!

    AP Entertainment SummaryBrief at 1:51 p.m. EDT – Channel 3000

    Entertainment Highlights: Key Updates You Can’t Miss

    ‘Devil Wears Prada 2’ casts Anne Hathaway’s love interest replacing Adrian Grenier’s Nate – Entertainment Weekly

    Devil Wears Prada 2′ Casts New Love Interest for Anne Hathaway, Replacing Adrian Grenier’s Nate

    12 ‘Late Show’ Moments Proving Stephen Colbert Can’t Be Replaced – The Mountaineer

    12 Unforgettable ‘Late Show’ Moments That Prove Stephen Colbert Is Truly One of a Kind

    Canes owner Tom Dundon’s real estate firm eyes entertainment complex near RDU – The Business Journals

    Canes Owner Tom Dundon’s Real Estate Firm Unveils Plans for Thrilling New Entertainment Complex Near RDU

    Inspired Entertainment, Inc.’s (NASDAQ:INSE) Price Is Right But Growth Is Lacking After Shares Rocket 29% – simplywall.st

    Inspired Entertainment Soars 29% but Growth Momentum Falls Short

  • 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
    Behind the Screens: The Impact of Technology on Real Estate – TRREB

    Behind the Screens: How Technology is Transforming the Future of Real Estate

    Sustainserv and Palau Announce Technology Partnership to Leverage Innovative AI Platform to Advance Sustainability Reporting – Business Wire

    Sustainserv and Palau Team Up to Transform Sustainability Reporting with Breakthrough AI Technology

    Morgan Adamski Joins PwC in Newly Created Cyber, Data & Technology Risk Division – HSToday

    Morgan Adamski Leads the Charge in PwC’s Cutting-Edge Cyber, Data & Technology Risk Division

    Transformative technology, support for food entrepreneurs spotlighted – University of Hawaii System

    How Cutting-Edge Technology and Strong Support Are Revolutionizing Food Entrepreneurs’ Success

    Cold Weather Alloy Opens New Possibilities for Space Technology – Universe Today

    Revolutionary Cold Weather Alloy Unlocks New Frontiers in Space Technology

    Defence Holdings PLC Transitions from Esports to Pioneering Defence 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#

Behind the Screens: The Impact of Technology on Real Estate – TRREB

Behind the Screens: How Technology is Transforming the Future of Real Estate

July 24, 2025
Gustavus hires Jordan Benson as Sports Information Director – Minnesota Intercollegiate Athletic Conference

Gustavus Welcomes Jordan Benson as New Sports Information Director

July 24, 2025
Join the Neighborhood Ecology Corps – RaleighNC.gov

Join the Neighborhood Ecology Corps – RaleighNC.gov

July 24, 2025

WEBS Program Ignites Passion for Science with Exciting Hands-On Labs

July 24, 2025

Science Explains Why Some People Keep Making Bad Decisions Even After Being Punished – Study Finds

July 24, 2025
Fidel Castro’s grandson slammed for flaunting lavish lifestyle amid Cuba’s economic crisis – Mint

Fidel Castro’s Grandson Stuns Nation with Lavish Lifestyle Amid Cuba’s Economic Struggles

July 23, 2025
Art on the Road: Framing the World – Oregon ArtsWatch

Art on the Road: Framing the World – Oregon ArtsWatch

July 23, 2025
Zimbabwe Says Informal Sector Dominates 76% of The Economy – Bloomberg

Zimbabwe’s Informal Sector Now Powers 76% of the Economy

July 23, 2025
MSC Cruises Unveils Entertainment Venues Aboard New Ship MSC World Asia – TravelPulse

Explore the Thrilling New Entertainment Venues Aboard MSC World Asia!

July 23, 2025
Mitochondria and health – National Institutes of Health (NIH) | (.gov)

Unlocking the Power of Mitochondria: The Key to Better Health

July 23, 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 (736)
  • Economy (759)
  • Entertainment (21,642)
  • General (16,069)
  • Health (9,797)
  • Lifestyle (767)
  • News (22,149)
  • People (761)
  • Politics (768)
  • Science (15,975)
  • Sports (21,257)
  • Technology (15,742)
  • World (742)

Recent News

Behind the Screens: The Impact of Technology on Real Estate – TRREB

Behind the Screens: How Technology is Transforming the Future of Real Estate

July 24, 2025
Gustavus hires Jordan Benson as Sports Information Director – Minnesota Intercollegiate Athletic Conference

Gustavus Welcomes Jordan Benson as New Sports Information Director

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