Technical Writing

322

Solutions

15

Content

i
The collection of articles, videos, and posts on this topic.

284

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

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
2 Comments
Python 3 Fundamentals
LVL 12
Python 3 Fundamentals

This course will teach participants about installing and configuring Python, syntax, importing, statements, types, strings, booleans, files, lists, tuples, comprehensions, functions, and classes.

Learn More!
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
3 Comments
===  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
4 Comments
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
19 Comments
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
8 Comments
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
8 Comments
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
6 Comments
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
2 Comments
I need a quick write up on Cloud Continuous Monitoring (ConMon)

Section 1.1  Purpose & Objectives

Section 1.2 Process Overview ( Operational Visibility, Change Control, Incident Response)

I attached two Fed RAmp Documents. Policy writing isn't my thing at all.
CSP_Continuous_Monitoring_Strategy_G.pdf
nistspecialpublication800-137-5b1-5d.pdf
0
0 Comments
== 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
3 Comments
Rowby Goren Makes an Impact on Screen and Online
LVL 12
Rowby Goren Makes an Impact on Screen and Online

Learn about longtime user Rowby Goren and his great contributions to the site. We explore his method for posing questions that are likely to yield a solution, and take a look at how his career transformed from a Hollywood writer to a website entrepreneur.

Read On!
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
2 Comments
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
10 Comments
========= 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
3 Comments
============ 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
4 Comments
=  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
4 Comments
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
2 Comments
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
8 Comments
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
6 Comments
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
6 Comments
Build an E-Commerce Site with Angular 5
LVL 12
Build an E-Commerce Site with Angular 5

Learn how to build an E-Commerce site with Angular 5, a JavaScript framework used by developers to build web, desktop, and mobile applications.

Enroll Today!
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
20 Comments
Log in to the payroll system
or
Log into the payroll system

Which one?
0
7 Comments
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
1 Comment
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
4 Comments
Hello,

We have a shared document on docs.google.com. It's owned by a manager (call him Joe) who shared the doc with me.

When I make changes, it appears that Joe receives an email notification. (He mentioned it happened when I resolved a comment, and I suspect it would occur for other changes as well.)

However, when Joe makes a change (add a comment, add a line of text), I do not receive any emails.

On drive.google.com, I checked Settings --> Notifications, and saw the following, indicating I expect to receive emails.
Google Drive Notifications Options
Could it be:
  • Should I be looking at options within docs.google.com instead of drive.google.com? If so, please advise how I can find these options.
  • Is the document owner the only person who receives notifications?
  • Something else?

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

Technical Writing

322

Solutions

15

Content

i
The collection of articles, videos, and posts on this topic.

284

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
>
Hall of FameAnnual Expert Awards