Technical Writing

256

Solutions

6

Articles & Videos

233

Contributors

Technical writing is any written form of writing or drafting technical communication used in a variety of technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, consumer electronics, and biotechnology. IT encompasses the largest sub-field within technical communication. The Society for Technical Communication defines technical communication as any form of communication that exhibits one or more of the following characteristics: "(1) communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations; (2) communicating through technology, such as web pages, help files, or social media sites; or (3) providing instructions about how to do something, regardless of the task's technical nature".

Share tech news, updates, or what's on your mind.

Sign up to Post

Hi,

I'm getting up to speed with using SnagIt for screen captures. I'm trying to add a text box with an arrow pointing to a component of the screenshot.

While I can type text into a whitespace area of the screenshot, it displays w/o a border.  So, I need to figure out how to add the border. If SnagIt could do it automatically, like MS Word does for text boxes, that would be great. In addition, what's the best way to add a red arrow?

Thanks,
Steve
0
Industry Leaders: We Want Your Opinion!
Industry Leaders: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

I am looking for some kind of website where I can find sample proposals for different kind of IT projects? I know I can deliver the technology to my clients but I can't write a decent proposal which probably caused me to loose several bids. I right for example I am writing one for a VDI solution for a school. Does anyone know any resources?

Thank you!

Martin
0
Hello,

In  a web application, we have a horizontal area of the screen displaying various metrics. e.g. (scrubbed)

Temperature     Humidity     Wind Direction  Wind Speed  Barometer
        74                    53%                 SW                         10 MPH        29.86


It's not a toolbar or ribbon b/c it's display-only. Accordingly, is there a more concise name than "screen area"?  I suppose I could say "section", but I'm not thrilled with that word. :)

Thanks,
Steve
0
Hi,

I'm documenting a time field that displays (e.g) 10;42:38.496
where .496 is 496 thousandths of a second.

So, if I say
HH:MM:SS.xxx, which are the letters to use for xxx?

Thanks,
Steve
0
Hello,

What is the proper terminology for a horizontal area at the top of a screen that contains not only menu choices, but also other options (e.g. change password, configure screen layout, etc.) I can't truly call it a menu, so what works? Panel? Bar? Something else?

Unfortunately, I cannot provide a screenshot b/c the software's proprietary.

Thanks,
Steve
0
Dear colleagues, I'm trying to find
Network diagram examples and official requirements for all 7 layers.
And also I would like these requirements with citing sources.
0
What is the best way to write an essay step by step?
0
Hello,

I'm documenting a report that includes a dropdown menu for date selection. e.g.

Today
This Week
This Month
This Year
Custom Date Range


Is it correct to say:
Select your Date Range from the dropdown menu?

I ask b/c to me, a Date RANGE is when you specify a starting and ending date (e.g. 5/10/2017 to 5/16/2017).

If "Date Range" is not appropriate,what would be?

Thanks,
Steve
0
Hi there,

I am curious to know if there is a process to help map all DIACAP controls to RMF ? Or if there is already a mapping that was done for this already.

Please let me know your suggestions or experience. Any bit helps

-Michelle
0
A big percent of today’s marketing activity is performed through the online environment. The marketing strategies that have existed a decade ago no longer relate to what’s happening today. We’re currently facing a revolutionary era, called the digital era. In ten years, the technology has developed
0
Free Tool: IP Lookup
LVL 8
Free Tool: IP Lookup

Get more info about an IP address or domain name, such as organization, abuse contacts and geolocation.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

6
For years, I was taught, I saw and I wrote that the area in the lower right corner of the Windows UI was the System Tray or Systray.
I just looked at the Microsoft Manual of Style 4th Ed and it's now called the Notification area.  
Where can I file formal complaint?  This is a stupid change.

Ugggh.
1
Hello,

I'm documenting a web application where the only way to exist is to exit the active browser window (tab?) in which the app is running.

Which is better terminology?

"To exit this application, close the active browser window"
"To exit this application, close the active browser tab""
<Something else>?

However I state it, I want to make it clear that you should not close the entire browser. :)

Thanks,
Steve
0
Hi,

I need to include a screenshot of a table that's displayed in a web app. This table contains (e.g.) one row for each day YTD, so, currently, it would be over 100 rows. I don't want to include all rows in screenshot, maybe just the first ten.

Is there a standard "indicator" to show the reader that the screenshot is truncated that non-technical people will understand?  Thanks.
0
Hi:

I'm writing a user manual with step-by-step actions and I'm looking for a web site or blog or pdf that has best practices for using colors in callouts, documenting keyboard mouse actions, etc.
0
Shaun asked me who are some budding writers here at EE that he should follow.  I obliged his request and showed him some members who write articles.  Check them out.

https://www.experts-exchange.com/posts/503/Kyle-Santos-My-feed-do-not-have-enough-technical-articl.html

5
 

Administrative Comment

by:Daniella Barion
Great!
0
Follow Lexie Lu if you enjoy articles about marketing, web design and graphic design.  She writes some great articles!

Click her profile and Follow.  Her articles are also listed there under 'Activity'.

https://www.experts-exchange.com/members/Lexie-Lu.html
5
 
LVL 6

Expert Comment

by:Brian Matis
Great idea, Kyle! I've seen several of her articles pop up in my feed because they're in topics I follow and have enjoyed them, so it certainly makes sense to follow her directly so I don't miss future ones :-)
1
 
LVL 1

Expert Comment

by:Juana Villa
Following :D
0
HI,
In a document, I'm showing the reader how to navigate to a particular screen "Add Users". Per existing style, (which I've inherited), I need to write something like:

User Portal --> Internal Users --> Add Users

But, I'd like to prefix this sequence with a single word. Would I say "Path"? "Navigation"? Something  else? e.g.

Path: User Portal --> Internal Users --> Add Users
Navigation: User Portal --> Internal Users --> Add Users

Thanks!
0
This is a neat tool for summarizing text and websites.  It's what the auto tl;dr bot uses on reddit.

http://smmry.com/
1
Transaction Monitoring Vs. Real User Monitoring
LVL 1
Transaction Monitoring Vs. Real User Monitoring

Synthetic Transaction Monitoring Vs. Real User Monitoring: When To Use Each Approach? In this article, we will discuss two major monitoring approaches: Synthetic Transaction and Real User Monitoring.

Hey everyone,

I am documenting a screen which supports a series of options (e.g. filter, sort, search, expand-a-field) that control the display of the data rows. Other options allow you do edit or delete data. Accordingly, I'm going to have two sections, along the lines of:

  1. Display Options
  2. Edit Functions

However, some of the rows have a column with the value "Display". :)  Accordingly, I want to avoid using "Display" in another context.

I hesitate to use www.thesaurus.com because it will spit out (or should I say "display" ;) ) a whole bunch of synonyms that have nothing to do with my context. Accordingly, I'm hoping one of you can suggest the right word.

Thanks,
Steve
0
Can someone point me to guidelines to be used for people who suffer from color blindness.
Colors and/or shades and/or shapes to avoid.
0
Hey everyone,

In the following sentence:

"This product is currently in Beta ,and will be released to all  customers in March."

Am I correct in capitalizing "Beta"?

Thanks,
Steve
0
I am higher secondary student and I want do many class works. Along with this work I have to write my assignment papers in which I cannot complete all my task works. I need much time to complete a single essay paper. So, I prefer to proceed with best online writing service. Does any one have idea about the best essay writing service?
0
Hey everyone,

Forgive the obtuse title. I'm trying to explain to users that they need to enter a code that can be 8 or 10 digits. Is the following correct?

"Enter the 8- or 10-digit activation code."

Is the hyphen after the number 8 correct?

Thanks,
Steve
0
I had this question after viewing Writing numbers of 1000 or more with decimals in technical documentation.

Hi again,

My API document (for a query), contains certain conventions I'm informally following:
- Numbers in a floating point calculation are written with a decimal place. (e.g. 100.0).
- Variable/object names in bold.

Accordingly, I plan to add a list of conventions. The question is, where to put it. This doc structure is as follows.
Query 1.
   Table of Input Data
   Table of Output Data
   Table of Error Message Formats
Query 2.
   Table of Input Data
   Table of Output Data
   Table of Error Message Formats
etc.
etc.

My gut feeling is to list the conventions one time, at the top of the document; however, in a large doc, if you're on page 35, do you really want to return to page 1 to remind yourself of the conventions? Maybe have a reminder at the beginning of each query or even each table?

Thanks.
0

Technical Writing

256

Solutions

6

Articles & Videos

233

Contributors

Technical writing is any written form of writing or drafting technical communication used in a variety of technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, consumer electronics, and biotechnology. IT encompasses the largest sub-field within technical communication. The Society for Technical Communication defines technical communication as any form of communication that exhibits one or more of the following characteristics: "(1) communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations; (2) communicating through technology, such as web pages, help files, or social media sites; or (3) providing instructions about how to do something, regardless of the task's technical nature".

Top Experts In
Technical Writing
<
Monthly
>