Technical Writing

242

Solutions

5

Articles & Videos

212

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".

Refine results

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

65 views
Courses: Start Training Online With Pros, Today
Courses: Start Training Online With Pros, Today

Brush up on the basics or master the advanced techniques required to earn essential industry certifications, with Courses. Enroll in a course and start learning today. Training topics range from Android App Dev to the Xen Virtualization Platform.

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 …

29 views

I had this question after viewing Writing numbers of 1000 or more with decimals in technical documentation …

510 views

Hi,

In writing technical documentation (in this case an API guide:
If I need to write the number 1000, I like to write as 1,000

However, if I need to write 1000.0 or 1000.1, is the comma still …

1014 views

Hey everyone,
For the following sentence, which of the below is correct?

"You need write access to your CD-ROM drive to take advantage of this feature..."
"You need write access on your CD-ROM …

730 views

Hi,
Is there any template or Software to write user guide for a software.

Cheers

247 views

Hi Experts,

I'm writing a user-facing document that instructs the reader to click the icon below. Is there a standard name for it?



Thanks,
Steve

1052 views
Resume Writing

Whether you're looking for first tech job or your hundredth job, the process can feel like a long, hard struggle. It can be made easier with the help of a good resume.

0262 views

Dear XX,

I would like to have below clarification regarding the course before I proceed further to enroll.

If for some personal reasons, If I want to to give a pause to the course enrolled for …

259 views

All technical issues from server side has been resolved(like Memory, File system level bankup … …etc.)
Apparently environment is stable now.
Dear XX,

this is to inform you that, The only task …

354 views
Gigs: Get Your Project Delivered by an Expert
Gigs: Get Your Project Delivered by an Expert

Select from freelancers specializing in everything from database administration to programming, who have proven themselves as experts in their field. Hire the best, collaborate easily, pay securely and get projects done right.

Until today I am under the assumption that,  Row over this matter concluded long before. After getting your call yesterday, understand apparently  it was not true.

A  month before, when you whatsup…

365 views

Greetings EE'ers,

My company is looking at instituting a policy in which that if they pay to send you to technical or any type of certification training, that the cost of that would be recoverable …

8101 views

Hello,

The following "thingy" (trying to use a general term here :) ), is part of a web application...it is just one portion of a screen with many components.



What would you call it in …

1278 views

When I write formal technical documentation, I tend to avoid contractions (e.g. you're) per "best practices". However, I'm writing a text box for a screen shot where "real estate" is at a premium. :) …

266 views

Hey Everyone,

I'm documenting a web application in which one can "hover" over (with the mouse pointer) an on-screen field to display more info. What is the most-accepted terminology that most/all …

478 views

Hey everyone,

I have a feeling there may be multiple opinions on this one, but looking for some feedback.

I am documenting a web app that contains numerous forms to fill out. To guide the …

1199 views

Hi,
I'm importing a Word doc into my company's Wiki,  in Confluence. Unfortunately, the Confluence "Office Connector" has several documented issues (and one I noticed that is not documented) that …

9255 views

I am documenting a Web app which includes the following screen. (Redacted significantly.)  I am looking for the correct term to use when referring to the left-hand portion of the screen? Pane? Panel? …

887 views

Hi,
In the document suite I am maintaining/adding to, I'm using boldface text to indicate user input on a field e.g.
1) Enter $1.00
2) EnterYES

Semantic issue: I'm thinking I should NOT end …

467 views
Live: Real-Time Solutions, Start Here
Live: Real-Time Solutions, Start Here

Receive instant 1:1 support from technology experts, using our real-time conversation and whiteboard interface. Your first 5 minutes are always free.

Can:
downarrow
uparrow
rightarrow
leftarrow

be expressed as one word in a technical doc. (e.g. a user manual)?

Dictionary.com contains only uparrow:

1091 views

Read about how to approach blogging and about ways to do it right. Stand out from the crowd and let your knowledge be consumed by a large audience. This article aims to explain how your blog should look like,  the most important things to do while building it, and how to connect with other experts.

0517 views

Dear experts,

Is there a template that I can download as I want to write a technical assessment of network, systems and telecommunication.

Thank you

1159 views

This question is related to:

http://www.experts-exchange.com/questions/28930979/Importing-Word-document-from-Confluence-workarounds-for-formatting-issues-etc.html

My client publishes Tech …

14145 views

Hi,

I'm documenting a web app. if I want to instruct the user to click a particular choice (for lack of a better word), I write something like:

Click Exclude.

However, suppose I have a field …

17130 views

Hello Experts,

Which way is correct in writing as I'm confusing with the "Troubleshoot vs Troubleshooting"

a. "I'm so sorry to hear that you have an issue with the Microwave and want to say …

4116 views
Show more content
201506-LO-Top-001
Top Experts In In
Technical Writing
<
Monthly
>

TOP EXPERTS

view all

RELATED TOPICS view all topics

  1. Proofreading
    (356)
  2. Miscellaneous
    (25,325)
  3. Security
    (23,340)
  4. Web Languages and Standards
    (39,503)
  5. MS Word
    (27,059)
  6. Web Applications
    (14,064)
  7. Content Management
    (2,755)
  8. Software-Other
    (37,458)
  9. MS Office
    (57,233)