Technical Writing

341

Solutions

293

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, this question is related to:
https://www.experts-exchange.com/questions/29141798/Tech-Writing-Need-less-technical-term-than-granularity.html

If I have a graph in a document with three lines (e.g. red, green, orange), I believe that the supporting info that shows that red=max profit, green = min profit, and orange = average profit is called a "legend".

But what do you call the values along the bottom (x-axis) (e.g. 4/1, 4/8, 4/15). The scale? Can it also be called a legend? Thanks.
0
Microsoft Azure 2017
LVL 13
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.

In a web application, the user has the choice of choosing daily, weekly, or monthly as the time interval along the bottom of a graph that controls the data points.

In my current revision, I say something like:
Please choose the granularity of the graph (Daily/Weekly/Monthly)

Even though our audience is reasonably technical, I'm not sure everyone will understand "granularity".

 Is there a better term I could use?
Thanks.
0
Dear All,

I am creating a new email to send to our users in our company although we have an IT Outsourcing supporting us with some critical request. I will be the man that helps to give a fast response to users in the house. I need to create an email telling users about the new IT Support email and telling users that they should contact me for any IT issues so I can delegate them or solve them in house.

Would you be able to create a template for me or advise me a site where there are email templates for IT?

This looks a bit dum to ask but my time is a bit short, and I need to speed up a few tasks.
Can you please advise?

Best regards,
Eduardo
0
when I was joined ABC company 10 years ago,for the maintenance project of 3 years contract, by then project had already been completed one year of it's tenure.
0
Help with technical grammar.

is it:
Logging into the system
or
Logging in to the system.
0
1)
The reason why I asked this, After having brief evaluation of the candidate profile and finds any merit in that, as a next step candidate is going be enrolled.
once they kick-off the processing typically follow a rule that, if the candidate doesn't succeed getting visa within defined timeframe they consider returning some percentage of processing fee ?

2)
I prefer to have consultation UAE time, between 4PM-10PM ?
0
I am interested to have consultation with Pittu more likely this friday.

However,I just wanted to know, As per my profile, Chances of getting PR depend on getting job offer from designate employer.As you know,my current consultant doesn't have that level of competency to handle such tasks,For any reason if that not materialized here too,how the arrangement of paid fee would be?

Appreciate your patience so far
0
1)
May I suggest you something? Please don?t worry about logistics. We can together sort this out. We have a ton of clients from your part of the World and we started using BoTim based on their request only. If you kindly take my suggestion, please let me share the link, you pay, let me book the slot first. Then we have good 5 days to figure the logistics part. David slots gets filled up very quickly and I honestly don?t want you to loose out time. Each day gone is a loss of competitive position as far as Canadian immigration is concerned.

Please go ahead. Rest all will be sorted.
2)
A final query .... Can I attend call along with my friend, if he satisfied, then he also could be your prospective client ?
0
Dear Team,
I wonder how you are able to respond so fast all over the day ! Much appreciated !

As I said before, Botim app I have never used. Skype need to be tested via VPN.
How can we make sure whether these are going to work prior to our scheduled call ?

==
0
I am not aware of Botim app used for calling purpose.For the skype, I need to check whether is it going to work with some kind of vpn help. I would prefer to have a call on Friday/Saturday. These days are observed as the weekend for us.

Please let me know, If I miss out asking any clarifications during the conversation, can we shoot a mail for our queries?
0
OWASP: Forgery and Phishing
LVL 13
OWASP: Forgery and Phishing

Learn the techniques to avoid forgery and phishing attacks and the types of attacks an application or network may face.

I appreciate expressing your forthright view about my profile.

If there is any fat chances as you suggested, then I would definitely be interested to go with you.
At this point of time based on my below profile, not sure If I can make it to the score-67.

To be honest with you, Currently I have enrolled with one of PR consultant and paid processing fees.
He is suggesting to get score of 67, to create my profile in EE, then only he can take my process further.Same lines as you said in mail, He told me good to have -Canadian job offer, to get the required score.He envisaged that, achieving it impossible. Reason being is,This processes has to be vetted by govt and it is being cumbersome required lot of scrutiny and then eventually luck plays the role.

As am rookie in this subject,Just got confused how to procede further from here?
I saw lot of video's on your youtube channel, hoping you are more trustworthy and take the process to logical end.

Again, I am furnishing more detail information about my profile, that would help you to re-assess my chances of getting visa.
0
which is correct sentence and why

1)
There are possible risks, but nonetheless, we feel it’s a sound investment;
-OR-
There are possible risks, nonetheless, we feel it’s a sound investment;

==
2)
Their team hadn’t lost a game the entire season. but Nevertheless, we beat them by a huge margin last night;
-OR-
Their team hadn’t lost a game the entire season. Nevertheless, we beat them by a huge margin last night;
0
I've run into a silly grammatical question. I have an introductory sentence that refers to a sequential instruction set below. This instruction set is just the basics, and the user can click a link if he wants to see the gory details. :)

So, I have:

To enter minimal information (click here for full instructions):
1,. Enter vendor name.
2.  Enter vendor email.
....
5.  Click "SAVE" when done.

On that first line, is my syntax grammatically correct? Thanks. If not, how should it be modified?

Thanks,
Steve
0
Hello,

For a web application, documented in a Wiki, I have a data element (call it THING) which can contain one or more WIDGETS  There exist two places in the instruction set for THING where I refer the user to the separate instructions for WIDGET.

TO ENTER A THING:

1. blah blah blah
2. Enter a Widget. Click here for info. ("Here" takes you to a separate section for widget entry,))
3. To generate additional sequential widgets (one more month)
     a. Click "GENERATE SEQ"
     b. Enter number of Widgets
     c. For each month, enter a widget. Click here for info.
4. Enter notes for the Thing.
5. Click OK to Save.

My instructions to enter a widget are somewhat involved, and, in the interest of "reusability" are contained in their own section.

Widget Entry: (located in its own section which I can link to.)
1. Enter cost.
2. Enter date.
3 etc.
4 etc.

To my question: after user completes step 4, I want him to return to the "Thing" instruction at the point where he left off. (which could be one of two places. How can I best handle this situation. I see two possible ways:

1. Say nothing, and trust that the reader will know to click the BACK Button to return to where he left off in the instructions.
2. Write something like "Return to Enter Thing instructions where you left off" to gently nudge him to hit the BACK button. (To avoid the temptation for wandering eyes to continue with the next section in the document.)

Thanks,
Steve
0
which one below is correct and why
==========

lately, my height has increased tremendously
lately, my height has been increased tremendously
0
which one below is correct and why
==========

I have a car / I had a car
I had little interest in driving / I have little interest in driving

==
0
In a user document, I have something like the following (scrubbed).

Select a company name. (e.g. Microsoft)

Do I need a period after "Microsoft"?  I'm leaning toward not needing it b/c "e.g. Microsoft" is not really a sentence, but then again, what do I know?

Thanks.
0
I have a series of apx  25 documents that describe 25 instances of a configuration screen on which you select - or enter - one or more data elements.. Each screen deals with a different concept (e.g. age, gender, etc).) But they all have common elements (e.g. how to clear all settings, how to display only selected items etc.

I'm leaning toward including these concepts on each of the 25 pages. (Ease of reading for our audience.) But, if, for some reason, our developers change the process of (e.g.) deleting all data elements), they I'd have to change it in 25 places.

I guess I could include these commands on a separate page, and simply say (on the 25 pages), "Click here for global commands."

Thoughts?
Thanks,
Stephen
0
Planing marriage and property distribution
---------------------
I agree with the view that, this is the right time to start searching a groom for NANCY. As I had already explained to mother regarding this subject, The solution is, let get over the property distribution process, then we will get to know how much share NANCY’s family is going to own, based on the outcome we can make a better decision for her life. Apart from that, MARIA also in the pipeline for similar reason, possibly within a period of 1-2 years, the above solution will fix the issue once for all. By doing so, will get the opportunity to know, Do they even need any support system at all from outside. Moreover, As for as NANCY’s family concern, the property they expected to get, none but she is going to own it as no other heir to share it. Regarding MARIA,  having $1 Million property with clear title in hand, which they can liquidate anytime, PLUS agri land which they are anticipating, aggregate of the both, would be more than sufficient not just for her marriage, even for next family generation needs. Now, If we go with your thought process for NANCY’s, then people would expect to apply same logic in case of MARIA also.

Having said that, Uncle categorically agreed to take care of all monetary expenses which would incur for her marriage. I made this to happen because neither he looked after BOTH families after their guardian passed away, nor done any justice yet to get their share of the property, and …
0
Starting with Angular 5
LVL 13
Starting with Angular 5

Learn the essential features and functions of the popular JavaScript framework for building mobile, desktop and web applications.

===  Giving advise to distribute family property which has been pending ... casing problems in a family
Uncle's lackadaisical attitude getting things even worse for each passing day to get our due share from the joint property, on which PAUL lifeline solely depended on. The delay made us to lose all Govt benefits for every now and then, very lately allowances which has started giving away for every 6 months based on size of land, and typical loan waivers offered when every new Govt assumes the office, which has been going on since ages. The sum total so far has been very huge and counterproductive so far to NASAR progress too. If this situation lingers for more time, In the prevailing social landscape, and with the changing Govt policies with the time, then it is almost impossible to dream to get the due share in property our lifetime. This effect already visible in the form of huge mistrust brewing while distributing crop share amount to relevant shareholders. For all these kind of nonsensical things I hold him responsible.

In conclusion, Let Uncle react positive to culminate property distribution process, the subsequent process would be transparent everyone to see how to plan their future support system and needs. This is an opportunity to all of us, what they are going to own vis-a-vis Needed in future, else Uncle has to take care of all expenses End-2-End for GIRL1 marriage and also for one more similar on the cards offing now. Now entire onus lies on him. Otherwise,…
0
Hi,

I'm documenting a connected series of screens that contains list of geographic locations. There are three screens;
  • Continent
  • Country
  • State

Each geographic entity can be assigned a value. e.g.
  • North America = 3
  • USA = 6
  • Ohio = 4

The returned value is the one for the most specific entity:]
  • If you are in Ohio: 4
  • If you are in the USA but not in Ohio: 6
  • If you are in North America but not in USA: 3
For this document, I have an intro, and then three sections (Continent/Country/State)

Would it be better practice to repeat the above derivation of the returned value in each section (3 instances) or just once (in the intro).  My concern is that if I put it in the intro, and someone is reading only the State section, they'd miss out on this explanation.

What you do think?

Thanks,
Steve
0
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
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

Technical Writing

341

Solutions

293

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