Engage with tech pros in our community with native advertising, as a Vendor Expert, and more.
Articles & Videos
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".
I'm writing a user-facing document that instructs the reader to click the icon below. Is there a standard name for it?
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.
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 …
All technical issues from server side has been resolved(like Memory, File system level bankup … …etc.)
Apparently environment is stable now.
this is to inform you that, The only task lef…
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…
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 …
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 tech…
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. :) …
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 u…
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 reader…
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 com…
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? …
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
Semantic issue: I'm thinking I should NOT end suc…
be expressed as one word in a technical doc. (e.g. a user manual)?
Dictionary.com contains only uparrow:
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.
Is there a template that I can download as I want to write a technical assessment of network, systems and telecommunication.
This question is related to:
My client publishes Tech Writin…
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:
However, suppose I have a field …
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 than…
Please help with one is the correct way to say:
a. "Let the door remains open for another day".
b. "Let the door remain opens for another day".
Which sentences is correct?
a. "The reason I was not happy is because you had done something wrong."
b. "The reason I was not happy is because you have done something wrong."
Which one is correct when I write this:
a. I emailed customer and asked him...
b. I emailed to customer and asked him...
"It will support..." or "It will supports..."
"She promised me she will support me" or "She promised me she would support me"
Which way is correct?
Hello Everyone, we can have the best venue in the City. I would like your help to make sure that this adjustment sound professional but also very appealing for the owner of the club who will read it. …
This article is a requirements document template for a reporting project, based on my development experience as an SSRS, Crystal Reports, and Access developer over the years. For a Re…
Would you like to write a technical article and have it published? Great! Welcome to our world! This is my tutorial on how to increase the odds of getting your article published and with honors, and is …
1,000 points this week
Minneapolis, Minnesota, United States
500 points this week
Joe Winograd, EE MVE
Greater Chicago Area, United States
500 points this week
Eden Prairie, Minnesota, United States
262 points this week
Sydney, New South Wales, Australia
108 points this week