Skip to main content

Questions tagged [tech-writing]

Production of technical documentation to help people understand and use a product or service.

Filter by
Sorted by
Tagged with
-1 votes
1 answer
23 views

The usage of "side" [closed]

I am currently working on scientific writing in English. I am trying to describe a plane with an elliptical hole, and this hole has two cracks. The cracks are collinear, positioned on the left and ...
Elliot's user avatar
  • 11
2 votes
1 answer
352 views

Tech-related: should I capitalize the word 'Git' in this context or not?

Which one is proper: the one with 'Git' capitalized or the one without? Configure git commit signing. or Configure Git commit signing.
Zoltan King's user avatar
0 votes
6 answers
376 views

'Pair' versus 'set' when referring to two things that aren't the same but still go together

Can the word "pair" be used for two things that are not exactly the same but are part of the same package? Let's say that we have two color schemes (or themes) for a computer program. One ...
Zoltan King's user avatar
2 votes
1 answer
70 views

Should one avoid hyphenating prefixed words in scientific papers?

I have noticed that many papers and books (in the engineering and mathematical fields, at least) have a preference for avoiding hyphenated prefixes. For instance, they usually write: preprocessing ...
Rubem Pacelli's user avatar
0 votes
0 answers
46 views

Do you click, tap, tab to or select a link in 2023? [duplicate]

Considering the many ways in which people can interact with web or app content – and especially wanting to include alternative accessibility tools, such as screen readers and more – is there a "...
Philipp Binggeli's user avatar
2 votes
2 answers
70 views

Where do I put the name of a noun, before or after? [closed]

Which one is better: When function read returns an error, the program crashes. When read function returns an error, the program crashes. When read-function returns an error, the program crashes. I'm ...
yegor256's user avatar
  • 135
0 votes
0 answers
43 views

Punctuation in a bulleted list, title and description

I'm making documention for a piece of software and I need to write multiple lists, namely menus and functions of the software. Currently items are formatted this way: • File ◦ New – ...
Mykola Tetiuk's user avatar
2 votes
5 answers
430 views

What is a technical term for "addressing reviewers comments"?

When collaborating on a document, reviewers will often leave comments. The process is complete once all the comments have been "_________" by the original author. ("Addressed" is ...
kmote's user avatar
  • 737
1 vote
0 answers
32 views

Are there any synonyms for phrases such as 'in fact', 'in practice', and 'practically speaking'? [closed]

In the context of formal article writing, sometimes, I have to use the phrases such as 'In fact', 'in practice', or 'practically speaking', are there any synonyms for these phrases to improve my ...
user288609's user avatar
0 votes
1 answer
250 views

Is the included sentence about party planning grammatically correct?

Is it correct to write the following? Since you have asked me about the planning of a farewell party for your English teacher, I’m happy to help you with some suggestions. Is there any way to ...
Sophia's user avatar
  • 3
-1 votes
2 answers
40 views

"As they are referred" vs. "As they appear" when we discuss terms and their definitions

I have a technical document that starts with an introduction section describing the key terms that are used in the document. What is the proper way to name this section? Path component names as they ...
user90726's user avatar
  • 555
0 votes
0 answers
130 views

Looking for a word that means helpful but not needed

This may be an odd word (not even sure if one exists), but I will give some context and maybe someone will be able to point me in the right direction. I am writing an essay on technology that is ...
smoochypea's user avatar
0 votes
0 answers
24 views

A combination of questions (Grammar, Writing and phrasal verb)

Q.1 what should I choose in the following context and why ? (early vs earlier) 1- I have been doing this since early/earlier this year. 2- This occurred early/earlier this year. Q.2 is the following ...
user avatar
2 votes
3 answers
218 views

An alternative to "normally"

From Microsoft Writing Style Guide: normally Don't use to mean often, usually, ordinarily, typically, generally, or a similar term. Here is examples that I have: But note that most information that ...
john c. j.'s user avatar
0 votes
1 answer
106 views

"Discouraged to" vs. "Recommended to not"

In the past, pregnant women have been recommended to not exercise because of presumed risks of preterm birth. In the past, pregnant women have been discouraged to exercise because of presumed risks of ...
user90726's user avatar
  • 555
0 votes
1 answer
74 views

To answer indirect question starting with "Whether" using "Yes" or "No" [closed]

I have a technical document with the following table: (A comparison table of the functions that are used to search for and replace strings.) | Whether the search is case-sensitive -----...
john c. j.'s user avatar
0 votes
0 answers
45 views

Parentheses instead of dashes: Is it required that the sentence will have the meaning with the "dashed" part omitted?

Else If and Else after jump statements Each guard must be a separate If with no Else If or Else. Otherwise—i.e., when a jump statement belongs to “normal” code and not a guard—Else If and Else must ...
john c. j.'s user avatar
0 votes
1 answer
73 views

What’s the normal software-engineering adjective which means that a function tolerates bad input? [closed]

There's a term used in software engineering that I can't recall, but which usually describes a subroutine that tolerates bad input. For example, let's say there's some method that converts raw string ...
HeyJude's user avatar
  • 857
0 votes
0 answers
62 views

Difference between "relationship" and "relation" [duplicate]

How can I easily differentiate between when to use "relationship" and "relation". More often than not, I tend to use "relationship", but would really like to know how these are to be used in writing. ...
MVS's user avatar
  • 7
2 votes
2 answers
147 views

A technical word to describe the correct contact between a wheel and a rail

I am translating an Italian technical manual, and I'm having problems translating one word in particular: "planaritá". The literal translation of the word is apparently "planarity" ...
Kevin Ryan's user avatar
0 votes
1 answer
1k views

How to name collection of web links? [closed]

I have a blog and from time to time I made posts that contains only web links with some short description. Those links was not so easy to gather and they are have a value by themselves. I call this ...
Sergey Ponomarev's user avatar
-1 votes
2 answers
148 views

Adjective for a "expected" or "aspirational" version of a document?

We're creating a user manual for a software application. Like the manual, the application itself is a work in progress. We have a version of the manual that describes the application as we expect it ...
Shawn V. Wilson's user avatar
0 votes
4 answers
589 views

In scientific writing is: Energy expended/ cost /consumed?

In scientific writing, should I write energy is expended, cost or consumed? Which term is preferable? As in the example, Energy is expended/cost/consumed through deformation/vibration/friction.
user avatar
2 votes
0 answers
328 views

Correct way to reference sub bullet list [closed]

d. Include documentation of rating ______ i. Show rating of ______ ii. Include overall ______ 1. Provide relevant documentation ______ In the example above, how would the last 3 ...
Relle's user avatar
  • 21
0 votes
2 answers
521 views

Possessive for abbreviation of a regular plural noun

How do you write the possessive for an abbreviation of a regular plural noun, when the plural 's' is not present in the abbreviation? I want to write "ten kilograms' weight" in a scientific context ...
Julian Newman's user avatar
2 votes
1 answer
916 views

Click the button "in" or "on" the window - Technical Writing [closed]

I'm writing instructions telling a user to click something in/on a computer window. I lean naturally towards "click the button in the window", but is it "click the button on the window"? (Note: this ...
Gwendolyn's user avatar
  • 321
1 vote
1 answer
164 views

Are there any guidelines for proper use of "creative" capitalization within in a technical report?

I am trying to edit a report that seems to have a lot of common nouns capitalized. My job is to edit for consistency of this style, which I am not familiar with. Does anyone have experience with what ...
SuziLmrdo's user avatar
0 votes
1 answer
107 views

How to indicate that verification/correction is requested in the document

I’ve been tasked to write a document (like a wiki) about an application for work. I don't know much about the app, other than what I'm understanding by reading the source code and minimal business ...
Chris22's user avatar
  • 101
0 votes
1 answer
71 views

How to punctuate two sentences that form one unit that requires a colon at the end? [closed]

I ask this in the context of comments in computer programming which are written in plain English. For this question, I require a colon at the end of every comment that is a heading of code. Now, if ...
h-h's user avatar
  • 27
0 votes
0 answers
122 views

One topic per paragraph when discussing advantages and disadvantages

I'm in the process of discussing advantages and disadvantages in a science paper I'm writing. I'm not sure if it's best to include them in two separate body paragraphs, one for advantages and one for ...
Josh's user avatar
  • 9
1 vote
2 answers
2k views

Is there an standard English dialect to use for programming and documents?

This question came up today in one of my code reviews at work. Where I used colour (South Africa English/British English) instead of color. Our company's opinion is to use American English for ...
Georg Steyn's user avatar
3 votes
2 answers
211 views

What is the collective name for the power, volume, and/or function buttons on a tablet?

I'm trying to be the most inclusive when writing a procedure that involves usage of a tablet computing device. I've read about hardware buttons for Microsoft Tablet PCs. I want to know if there's a ...
OwnDevise's user avatar
0 votes
1 answer
1k views

"The" before proper nouns in technical writing

Should I use "the" before proper nouns? I would like to skip it, will it be grammatically correct? Example: MicroApp receives the SL Recovery Key, the LF Service Key, and the Auth Key to control ...
Mary's user avatar
  • 3
0 votes
1 answer
1k views

Is it idiomatic to begin a sentence with "In address to"?

I would like to start a sentence with In address to. Example 1 In address to this problem, several examples have been presented. Example 2 In address to the trade-off between work and rest, as ...
Stephen's user avatar
  • 69
0 votes
2 answers
7k views

using the word "meaning" in a sentence to explain

I have the following sentence: This process is circuitous, meaning, the responsibility returns to the Originator user after all is approved. A few questions: I know this would be a fully ...
DAE's user avatar
  • 1,311
2 votes
3 answers
165 views

Which indefinite article to use if the noun starts with a non-letter character?

In the Perl programming language, symbols in front of variable names are called a sigil. When reading code out loud, the sigil is spoken. $foo becomes dollar foo. The sigil for functions is the ...
simbabque's user avatar
  • 133
2 votes
1 answer
16k views

Abbreviation "mm o.c." in construction (spacing of ducts etc)

What does o.c. stand for and what does this mean? These are some examples of its use: Space end bells approximately 250 mm o.c. for 125-mm ducts. Space fasteners at 10" (250 mm) o.c. on ...
Felix Dombek's user avatar
  • 1,270
2 votes
3 answers
2k views

Preferred American English term for the [enter/return] key in the keyboard

Problem A colleague is designing an application and wants to decide what to write in the return/enter key. Research In the Macbook keyboard both terms are present (return and enter). Question My ...
ppaulojr's user avatar
  • 133
0 votes
3 answers
602 views

Is the term "step-action table" jargon?

I'm an engineer. My doc team has been using step-action tables to create user-facing documentation for some software that I've built recently. I think these tables are awesome, but I keep seeing ...
Eric Hirst's user avatar
3 votes
1 answer
2k views

'finding' or 'discovery'

I am writing a scientific paper on physics. I hesitate to write that my observations and their interpretation is a 'discovery', so I am considering using the word 'finding' instead. Is this the ...
S. Kohn's user avatar
  • 131
6 votes
1 answer
1k views

What are these containers called?

The german term is Absetzmulde (Image search). They look like this: Image source: Sirch GmbH There are varios different styles of bulk goods containers that can be easily loaded on/off a truck, but ...
mart's user avatar
  • 213
5 votes
4 answers
7k views

Difference between "rule" and "law" in scientific context

In general, according to an article in DifferenceBetween.net The main difference between rules and laws is the consequences associated with breaking them. While each is developed to invoke a ...
Eilia's user avatar
  • 5,479
0 votes
1 answer
3k views

Synonym for "get affected by" in academic form?

I am writing a paper and I have some measurements and factors which change according to the change of some others. I have already used several times "A affects B". Therefore, I need to use a different ...
Konigin's user avatar
2 votes
2 answers
270 views

Is it true that people are unfamiliar with abbreviations like "i.e." and "e.g." and therefore it is best to avoid using them? [closed]

Is it true that people are generally unfamiliar with abbreviations like "i.e." and "e.g." and therefore it is best to avoid using them in technical writing? Avoid abbreviations such as “i.e.” and “...
user7610's user avatar
  • 315
0 votes
1 answer
643 views

How to describe all things we can do with an object? [closed]

I want to describe a set of functions (which belongs to a programming language) but i'm not really sure if my sentence is correct. This set of functions allows us to perform many mathematical ...
GniruT's user avatar
  • 113
2 votes
2 answers
968 views

Quoting a password at the end of a sentence: Where to put the point?

Recent Slashdot article: They feature Wi-Fi that can't be turned off (protected, however, with a WEP password of "abcde"), an unencrypted database, and administrative access with a hardcoded ...
Nicolas Raoul's user avatar
0 votes
2 answers
2k views

Introducing an alias in technical literature

In technical literature (namely, a requirements document), what is an appropriate way of introducing an alias which is used from there on; instead of the full, completely-defined term? I'm looking ...
Boris B.'s user avatar
  • 103
11 votes
5 answers
11k views

A word that means to both encrypt and decrypt [duplicate]

I am currently writing a small class in C# which will take an image, decompile it down to a byte array, obfuscate the data into a proprietary format (thus making it unreadable), and store said data ...
Krythic's user avatar
  • 530
1 vote
3 answers
2k views

Way to indicate the number of something

When I want to express the count of something, can I say "xxx number" instead of "the number of xxx"?  For example: "Location number" to mean the number of locations. &...
Jun Kyoto's user avatar
  • 325
4 votes
1 answer
105 views

Are these expressions to call of a particular kind of deviation right?

I am translating a material on visual sensors and having a hard time figuring out what to call this. The situation is that when the sensor senses a circle mark, sometimes it does not detect a fine ...
Jun Kyoto's user avatar
  • 325