Questions tagged [tech-writing]
Production of technical documentation to help people understand and use a product or service.
64
questions
-1
votes
1
answer
27
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 ...
- 11
2
votes
1
answer
417
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.
- 583
0
votes
6
answers
460
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 ...
- 583
2
votes
1
answer
78
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
...
- 123
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 "...
2
votes
2
answers
71
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 ...
- 135
0
votes
0
answers
44
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 – ...
- 101
2
votes
5
answers
496
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 ...
- 737
1
vote
0
answers
34
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 ...
- 111
0
votes
1
answer
253
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 ...
- 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 ...
- 555
0
votes
0
answers
148
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 ...
- 11
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 ...
user402480
2
votes
3
answers
226
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 ...
- 358
0
votes
1
answer
112
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 ...
- 555