[Product update] Infrastructure Analysis Tool is now available with Business Accounts.Learn More

x

Technical Writing

318

Solutions

279

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

which one is grammatically correct and why
==============================================
we dont need to go there because,we have not been invited.

we need not go there because,we were not invited.
0
Microsoft Azure 2017
LVL 12
Microsoft Azure 2017

Azure has a changed a lot since it was originally introduce by adding new services and features. Do you know everything you need to about Azure? This course will teach you about the Azure App Service, monitoring and application insights, DevOps, and Team Services.

which one is grammatically correct and why
===================================
1)
I wrote a book when I was in USA
I had written a book when I was in USA

2)
postman bought  a letter.   It was given to your mother.
postman  bought a letter.It has been given to your mother.
==
0
which one is correct and why ?
========================

you are not be permitted to go into theater if you dont have a ticket
you are not going to be permitted to go into theater if you dont have a ticket
you will not be permitted to go into theater if you dont have a ticket
0
Grammatically which one is correct, appreciate if you can add the reason too...
===================================================================
1)
This road  was not repaired for the last 5 years
This road  has not been repaired for the last 5 years

2)
this work must be completed in  a week
this work has to be completed in a week

3)
this work is not going to be completed in 2 days
this work won't be completed in 2 days

===
0
== Requesting company HR to share contact details of my previous colleagues ===

I am John,former colleague of David, who is working as Project Manager in your organization, had been associated with him during our previous job role with HP, Florida.
I would need to reach him for some personal purpose.

Kindly advice  ..
0
I've been testing Ginger in free mode for a while and they keep bugging me to upgrade (~$59 per year), but I am wonder about alternatives. Rather, I am wonder what you folks consider as the best on-line grammar checker, and why?

I have used Grammarly in the past but I recall that it often missed obvious errors and sometimes made erroneous suggestions. But that was about three years ago. I also know that there are a few other grammar checkers available.

Two Two that I have used are:
- Ginger https://www.gingersoftware.com
- https://www.grammarly.com

Criteria for answering
- Please don't suggest that there is no substitute for understanding English grammar. I know this. But these tools are still great for finding errors when one makes the occasional mistake.
- Please don't suggest the free tools in Microsoft Office. I don't have access to Office.
- I am primarily editing in Google mail and the Google Apps.
- I am only concerned about English grammar checking.

I'll look forward to your comments and suggestions. :)
0
In a web application, I have a field in a table that contains the following (scrubbed):
what is this
You can mouse over STATUS to display a popup that shows "Approved", "Deferred" etc.

But, what do you call STATUS. It's not a link, and not sure if it should be called an icon. But, if "Icon" is appropriate, I'll run with it. Thanks.
0
========= Seeking clarifications about documents  for my PR process ============
regarding ABC company experience ...I hope to get the "Roles and responsibilities" on their letter head very soon for my PR process.

Apart from above, I have  1) Exp letter & 2) Reliving letter, with me.

ABC is a human resources consultancy,  and no contemporary consultants are currently in touch.I used to depend on ABC only for my HR related needs.
whereas their customer-- "IDB bank"where I had worked ,  I have known contacts.
 
Hope the above three documents are sufficient.

please advice
0
============ Writing email to my previous company-ABC HR, Requesting her for employment refernce letters for my PR process  =======

It has been long time since I left the organisation. I must say experience with ABC had been wonderful, and its transparent HR process.
Still I miss the annual gatherring parties.Hope such parties still ABC keeping alive.

regarding reference letters I requested for my PR...
you might have provided such reference letters so far, for many PR aspirants. I didn't exactly get the reason for the delay getting requested letter.
If the reason for my employment,  my experience letters sent you in earlier communication, hope that will give you enough details.
More details you can get from your internal employee database.

About my job roles,as a IT Consultant,the document sent you mentioned most generic roles not to make it complicated.

I am waiting for your letters to procede next level of processing for my PR processing.

I am sure, you will help me getting the required documents in this regard, also wishes me to succeed.

I really appreciate your help
XXX
0
=  Writing mail for whatsup admin, reminding him  for not getting delivered daily lessons through his broadcast list =
Hello,

This is to inform you that, I have not received the -  Day-21 Evening lesson again.
Can you please kindly check again, whether my below number has added to your whatsup broadcast list.

my num # +1234567  ( Make sure '+' sign before the number).

Making you uncomfortable daily with reminders to send me lessons individually , I am feeling apologetic for that.

Just for Info, my cell has always been connected to High-Speed 4g, and it is a Samsung Note.
0
Why Diversity in Tech Matters
LVL 12
Why Diversity in Tech Matters

Kesha Williams, certified professional and software developer, explores the imbalance of diversity in the world of technology -- especially when it comes to hiring women. She showcases ways she's making a difference through the Colors of STEM program.

yesterday I received an update about my education credentials status.
One of the transcript not been accepted mentioned the below-given reason.
===  reason ==
XXX
====

Kindly advise, Shall I send you the photocopy of a statement of marks sheet which has the clear visibility to support my - "Statement of Marks-Transcript" submitted to you earlier.
0
Dear HR-Manager,

How have you been?
Hope you are keeping good health.

I had been your employee during the period 2005 to 2010 yr.
I have initiated the PR processing for countries CCC & DDD,I would need your help to submit some documents required in some defined format on company letter head(a scan copy) as part of the processing.

Apart from regular experience/relieving letters, process mandates job duties performed during my tenure with your client-"ABC" I had worked.
The job duties details I will send you in my next email once I got positive reply.

I hope, you definately take some effort to help company former employees to get the required scan copies.

For your reference, I have attached my experience letter.

Thanks for your support
XXXX
0
Hello,

I'm documenting a data table where you can filter on various columns. e.g. you choose Name, State or ZipCode from a drop-down menu.

So, one of my instructions will read: Select your ________ from the drop-down menu.

But, for the life of me, I'm blanking on how to fill in the blank. Would it be "criteria"? "column"? "field?"

Thanks,
Steve
0
Hi,

My application contains a number of gray circles with a line though it e.g. Circle
But it's rather faint, and would be hard to read on an instruction set if I took a screenshot.

There must be instances of this symbol in a darker gray than I have here, but I'm not having any luck Googling it (e.g. gray circle with line through it)

Where can I find a suitable example? Or maybe I just need a better search term for this symbol?

Thanks.
0
Hi,
I'm documenting a web application and came across this icon:
ThreeVerticalDots
When I click it, it displays a drop-down menu of options.

Is there a standard name for this icon?

Thanks,
Steve
0
Log in to the payroll system
or
Log into the payroll system

Which one?
0
Dear all

I have been asked to write a report to implement new projects I.e upgrading switches, WiFi, access control etc.

What other ppl are doing ?

Many thanks
MS
0
I am planing to have a visit to my home town next month for 3 weeks.
presently I have only few scan copies, about my experience and Education.

If I miss to arrange the required certs in this visit, then,my subsequent visit would be only after 5 months.

therefore, please let me know

1)Full-list of documents required to have, to procede for PR

2)Do you consider any reduction of processsing fee

3)If I am fortunate to get the PR, I wish to take my family only after spending some amount of time,to make myself comfortable.
  In such scenario, please let me know whether I have to pay the dependents fee upfront ?
 
4) My graduation is from an Autonous college  which Affliated from   , Post Graduation Engg college affliated directly from XX University.
   In such case, which is better option to show about my education details, Graducation/post graduation ?.
   I am not sure whether I can get the required transcripts for my graduation in my case.
   
5)I have been working in current Organization/Role since 2 yrs.
   My current job contract most likely end by coming Dec,
   Once I left from here, little difficult to procure the documents that I may be needed for our PR-processing
   please advice, what kind of documents I may be needed from current organization.
   
   Kindly refer my brief  biodata submiited to you to advice me further
0
In a web application, I have a screen that includes the following (redacted):
What is this icon?
The functionality is that if the thingy to the right of "Confirm" is not present, you can click Confirm to approve a transaction. If the thingy is present, there's an issue with the transaction and you can't approve it at this time.

But, what do I call it? Magnifying glass icon? Or is icon even the correct word.

Oh, the hairs I split... :)

Thanks,
Steve
0
CompTIA Network+
LVL 12
CompTIA Network+

Prepare for the CompTIA Network+ exam by learning how to troubleshoot, configure, and manage both wired and wireless networks.

Hello,

Since I'm not familiar with the MAC, (in fact, I don't have access to one) I have not encountered this syntax before.

In a set of Release Notes, I need to document a feature involving the MAC key combination COMMAND and Click.  Two questions:

1. What's the preferred syntax here?

<Command>-<Click>
<Cmd>-<Click>
Something else?

2. What's the correct verb? Press? Perform? Do? e.g.
Press <Command>-<Click>


Thanks,
Steve
0
Hey everyone,

In the web app I'm documenting we have a number of text fields where, when you start typing something, it displays a list of matches. e.g. if it were a "state" field you might have

New

   New Jersey
  New Mexico
  New York

You can then click the state you wish to select.

Am I correct in saying that the above is not a search box? (The database field is text.)
0
Hello,

To indicate an optional plural, I would write:

Select the checkbox(es) next to the item(s)

But, how about for a word such as "category".

Do I write:

Select the checkbox(es) next to the category(s)

(or)
Select the checkbox(es) next to the categor(ies)

While I suppose this sentence could be rewritten, all I"m looking for is the specific issue of (s) vs (ies).

Thank(s) :)
0
I'm documenting a screen in a web app that has a field that can store a temporal value. It can be in days, weeks, months, years depending on the setting of an adjacent drop-down menu.

e.g. (redacted):

Length of Contract:  ______   <days, weeks, months, years>

My question:

1. What would be a general term for the value placed in the blank field above. I considered Quantity and Amount, but I don't think these terms apply to temporal values.

2. And, while on the subject, how about for <days, weeks, months, years>. Maybe Time Period?

Thanks,
Steve
0
I had this question after viewing I need a synonym for the word "field" (Database context).

I'm documenting a web application screen that contains numerous fields per this redacted example for running (race) data for an athlete.

Date: 02/09/18
Race Name: Experts Exchange Challenge
Distance: 5 miles

Result:   Time: 39:09   PacePerMile: 7:50

Date, Race Name, and Distance are fields.

But how about Result and its elements (Time and PacePerMile)?  I'm calling Result a "field" and it elements "subfields".  Am I on safe ground? (My audience is technical people such as UX designers.)

Thanks!
0
I need a synonym for "field"  as in the database usage of the word (e.g. the first name field, last name field, address field, etc.)
0

Technical Writing

318

Solutions

279

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
>