* . *
  • About
  • Advertise
  • Privacy & Policy
  • Contact
Wednesday, September 17, 2025
Earth-News
  • Home
  • Business
  • Entertainment
    Gen V Season 2: What is The Odessa Project? – yahoo.com

    Gen V Season 2: Unlocking the Secrets of The Odessa Project

    PENN Entertainment stock rating reiterated at Market Outperform by JMP – Investing.com

    PENN Entertainment Stock Rated a Market Outperformer by Experts

    Here’s how NJ’s once-vibrant nightclub scene was born and why it died – Bergen Record

    The Rise and Fall of New Jersey’s Once-Vibrant Nightclub Scene: What Happened?

    The Emmys are back: Viewership soars to highest numbers in 4 years – yahoo.com

    The Emmys Return with a Bang: Viewership Hits a 4-Year High

    From Spinal Tap II to Ed Sheeran : your complete entertainment guide to the week ahead – The Guardian

    Fall’s Hottest Ski Films Are Going on Tour—Here’s the List – yahoo.com

    Experience the Thrill: Fall’s Hottest Ski Films Hit the Road-Don’t Miss the Tour!

  • 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
    City IT presented Best of North Carolina Technology Award – RaleighNC.gov

    City IT Honored with Best of North Carolina Technology Award

    LELO Releases 2025 Futurist Report: Intergenerational Views on Relationships, Sex, and Technology – PR Newswire

    Exploring the Future: How Different Generations View Relationships, Sex, and Technology in 2025

    Will New Big Technology Engagements Reshape Innodata’s Growth Path? – Yahoo Finance

    Could New Major Tech Partnerships Propel Innodata to Unprecedented Growth?

    Unlocking AI Success: How People, Process, and Technology Form the Ultimate Triangle

    Billion-dollar coffins? New technology could make oceans transparent and Aukus submarines vulnerable – The Guardian

    Billion-Dollar Coffins? How New Technology Could Make Oceans Transparent and Expose Submarines

    What if artificial intelligence is just a “normal” technology? – The Economist

    What if artificial intelligence is just a “normal” technology? – The Economist

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
  • Home
  • Business
  • Entertainment
    Gen V Season 2: What is The Odessa Project? – yahoo.com

    Gen V Season 2: Unlocking the Secrets of The Odessa Project

    PENN Entertainment stock rating reiterated at Market Outperform by JMP – Investing.com

    PENN Entertainment Stock Rated a Market Outperformer by Experts

    Here’s how NJ’s once-vibrant nightclub scene was born and why it died – Bergen Record

    The Rise and Fall of New Jersey’s Once-Vibrant Nightclub Scene: What Happened?

    The Emmys are back: Viewership soars to highest numbers in 4 years – yahoo.com

    The Emmys Return with a Bang: Viewership Hits a 4-Year High

    From Spinal Tap II to Ed Sheeran : your complete entertainment guide to the week ahead – The Guardian

    Fall’s Hottest Ski Films Are Going on Tour—Here’s the List – yahoo.com

    Experience the Thrill: Fall’s Hottest Ski Films Hit the Road-Don’t Miss the Tour!

  • 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
    City IT presented Best of North Carolina Technology Award – RaleighNC.gov

    City IT Honored with Best of North Carolina Technology Award

    LELO Releases 2025 Futurist Report: Intergenerational Views on Relationships, Sex, and Technology – PR Newswire

    Exploring the Future: How Different Generations View Relationships, Sex, and Technology in 2025

    Will New Big Technology Engagements Reshape Innodata’s Growth Path? – Yahoo Finance

    Could New Major Tech Partnerships Propel Innodata to Unprecedented Growth?

    Unlocking AI Success: How People, Process, and Technology Form the Ultimate Triangle

    Billion-dollar coffins? New technology could make oceans transparent and Aukus submarines vulnerable – The Guardian

    Billion-Dollar Coffins? How New Technology Could Make Oceans Transparent and Expose Submarines

    What if artificial intelligence is just a “normal” technology? – The Economist

    What if artificial intelligence is just a “normal” technology? – The Economist

    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

Docs Deserve More Respect

December 28, 2023
in Technology
Docs Deserve More Respect
Share on FacebookShare on Twitter

I’ve been doing technical writing of one sort or another since 1999, when I was doing QA for Altec Lansing’s R&D branch in Kfar Saba in Israel. Back then we would put out innovative, new audio related devices like (gasp) USB audio devices that worked on Windows ME and 2000. They were buggy and setting them up wasn’t the straightforward thing that it is today.

We needed docs.

We had some hoops that users had to jump through, and we needed a way to document what they were, what the edge cases were, and how to diagnose and fix all of that stuff. It needed to be nicely packaged, cleanly formatted, and accessible to users who installed our helper application. I found Robohelp, which created standard help applications, which could be added to our install.

During our QA process we would identify the issues, document what we thought was salient, and organize it into the help file that was bundled with the device. I was 19 at the time, and I had zero experience with this stuff, and it was an immensely naive process. But, it just felt like the right thing to do for our users, and my manager didn’t explicitly tell me not to.

It’s been 24 years, and since then I’ve done documentation for a bunch of projects. The scale has grown, and the way that I look at those types of projects has substantially changed.

I have some thoughts about what makes for good docs and I’d love to share them with you if you’re interested.

Core Concepts

Id like to start with a set of more concrete rules that I believe are critical to a documentation product’s success.

Docs should use small words to describe big ideas – so don’t use flourishy words or complex sentences to describe what can be said in simpler terms. You will lose users along the way and it isn’t worth your writer’s ego.

Docs should tell a story when you can – because a personal, relatable set of tasks that tell a tale will be more engaging and memorable for your user than an abstract set of instructions.

Docs should be searchable – because seriously: this is a no-brainer. If your docs are not easy to find stuff in, your users won’t find what they need.

Docs are almost always part of a larger strategy – and this is especially true when it comes to software products. This touches on the larger topic of developer advocacy, but in short: your docs should be supported by video tutorials, real use examples, and live technical support.

Docs should be tested – because you may be sure that everything is right, but without real users, like with any other product, you won’t know for certain. Test it and test it again.

Holistic docs are well-designed Products

When you learn a new programming language, concepts and ideas from that language flow into your bag of problem solving tricks. It makes you into a better software developer and at the end of the day, you make better software because you are more aware and capable.

My career has been a complicated one, and included a lot of software product design, software development, technical support, and developer advocacy. Each discipline has influenced how I think and approach the others.

When I approach a Technical Writing project, it’s with this broad view of what it is that a user is going to need. I think that’s the right way to think about docs: holistically. Docs aren’t a well-defined thing and to make good ones you have to be flexible.

To me, that means you have to think about your users from as many angles as possible. You can’t take anything for granted or you’re going to let some group of users down in a way that will negatively impact your brand, your product, or your business in a way that is hard to come back from.

Your docs are very often a make-it-or-break-it experience for your users.

If you did a good job, your users will use your product successfully, and become champions of your brand. If you don’t, they will likely never use your product again because your docs left a bad taste in their minds. They will also let others know. Good marketing starts here, so keep that in mind.

Making good docs

Making good docs simply means that you must approach your docs creation as you would any other product process.

You need to:

Know why you are creating your docs

Know who your target audience is

Know what their pain points are

Improve your docs over time

Let’s take a closer look at each of these.

Knowing the why of your docs is often a really straightforward question and answer set on its surface. You are creating docs because if you don’t, users will fall through the cracks and fail to use your product. At a deeper level there is a specific answer for your use-case. Have a developer tool? That’s one answer set. Have a retail design tool? Have an Accounting SaaS product? Have an automatic coffee maker? These are all separate answer sets.

The form of your docs is described by who will use it. Is it online? Is it bundled with an app? Is it printed? Every user base will need something else and you have to be clear from the get-go who they are.

Your job is to figure out what is hard for each of your users, and craft your docs around funneling them through informative content that solves for their specific problem.

Most importantly, you have know that you probably aren’t going to get it right the first time. That means that your docs need to be maintained and updated as your products grow and change over time. Hopefully, this is done within some framework which allows easy communication with those users you are trying to help. You have to talk to your users, listen to their needs, and try to use your docs to make their experience using your product a better one.

Your docs are an integral part of your success

I’ll sum up by simply underscoring how critically important docs are. Without them, your users are on their own and must fend for themselves.

This will always mean fewer success cases, poorer views of your product within your ecosystem, more unhappy developers or users, and a negative impact on your brand or company.

Docs are a serious sub-product in their own right, are an investment, and must be part of your wider product strategy.

>>> Read full article>>>
Copyright for syndicated content belongs to the linked Source : Hacker News – https://www.ramijames.com/thoughts/docs-deserve-more-respect

Tags: deserveRespecttechnology
Previous Post

Jerry (YC S17) Is Hiring PMs, Engineers, Data Roles (Remote)

Next Post

Book list for streetfighting computer scientists

The FCDO’s Approach to Displaced People – ReliefWeb

How the FCDO is Transforming Support for Displaced People

September 17, 2025
Indonesia ponders pro-growth mandate for central bank as economy flags – Financial Times

Indonesia ponders pro-growth mandate for central bank as economy flags – Financial Times

September 17, 2025
Gen V Season 2: What is The Odessa Project? – yahoo.com

Gen V Season 2: Unlocking the Secrets of The Odessa Project

September 17, 2025
Is the Economy as Healthy as Trump Claims? – The New York Times

Is the Economy as Healthy as Trump Claims? – The New York Times

September 17, 2025
Inside Stephen A. Smith’s near-$40M-a-year bonanza as he launches into political prime time – The New York Times

Inside Stephen A. Smith’s near-$40M-a-year bonanza as he launches into political prime time – The New York Times

September 17, 2025
Torch Lake faces ecological challenges from invasive Quagga Mussels – WPBN

Torch Lake Fights Back Against the Growing Threat of Invasive Quagga Mussels

September 17, 2025
New Data Science Minor Prepares Students for Data-Driven World – CSUF News

Unlock Your Potential with the Exciting New Data Science Minor Designed for a Data-Driven Future

September 17, 2025
Miami University’s Cleveland Clinic Health Sciences and Wellness facility. – Cleveland Clinic Newsroom

Explore Miami University’s Exciting New Cleveland Clinic Health Sciences and Wellness Center

September 17, 2025
This Is The Most Popular Soup In The U.S. Right Now—And It’s A Fall Classic – yahoo.com

This Fall’s Most Beloved Soup Is Taking the U.S. by Storm

September 17, 2025
City IT presented Best of North Carolina Technology Award – RaleighNC.gov

City IT Honored with Best of North Carolina Technology Award

September 17, 2025

Categories

Archives

September 2025
MTWTFSS
1234567
891011121314
15161718192021
22232425262728
2930 
« Aug    
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 (823)
  • Economy (843)
  • Entertainment (21,722)
  • General (17,086)
  • Health (9,888)
  • Lifestyle (857)
  • News (22,149)
  • People (847)
  • Politics (853)
  • Science (16,054)
  • Sports (21,343)
  • Technology (15,825)
  • World (827)

Recent News

The FCDO’s Approach to Displaced People – ReliefWeb

How the FCDO is Transforming Support for Displaced People

September 17, 2025
Indonesia ponders pro-growth mandate for central bank as economy flags – Financial Times

Indonesia ponders pro-growth mandate for central bank as economy flags – Financial Times

September 17, 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