Encompasses computer and technology writing, end-user documentation, code documentation, engineering, the sciences, consumer manuals, and more.

learn more… | top users | synonyms

0
votes
2answers
75 views

I am writing a book on web design. What elements should I remove to avoid copyright issues?

I am writing a book on web design, titled Best website design. I will list photos of some good-looking portfolio websites in the book. Do I need to take permission from the website owner? Will it be ...
0
votes
1answer
281 views

How would I say this in the reverse?

I am sending out a message to all users that have filed a bug report for my last game; the one I shut the server down on. The broadcast message I am sending is going to be an email, but I'm not ...
0
votes
2answers
169 views

Am I correctly referencing chapters which belong to the same book?

Looking for some help on how to reference chapters in a book inside of a booking I'm helping with. Should I be capitalizing Chapters 3 and 4 and would referring to chapters simply by capitalized ...
0
votes
1answer
23 views

Referring to a diagram

In a math book, should I write "diagram 3" or explicitly "diagram at the figure 3", when referring to a diagram in a displayed figure? (The title of the figure (as autogenerated by LaTeX) is "Figure 3....
0
votes
1answer
254 views

What is it called when an author uses vague words for concrete concepts, “hedging”?

As an editor for an academic press, my pet peeve is when authors write sentences like "attempt to conceive of a possible approach to resolve X" instead of "try to resolve X". Obviously one big ...
0
votes
1answer
98 views

Giving something an alias

Within a technical document I want to refer to a system or process by a shorter name. I have no idea what this process is called so searching the internet is not getting me anywhere. Is this correct? ...
0
votes
1answer
767 views

What are the names of the different levels of English?

In a recent discussion regarding software manuals, we came across the issue of different styles of writing / speaking in English. I am having a hard time finding a list of the different styles, such ...
0
votes
2answers
63 views

What is the correct word/term that needs to be before the names of the maker of the project?

I am doing a project with one other person, we have finished the project and we are working on a cover page. We are not sure what to write out before our names, we have thought of a couple of options,...
0
votes
1answer
51 views

How to communicate multiple meaning in a sentence more concisely?

Good day everyone, I have the following sentence: Around 70% of small businesses in the United States struggle to hire qualified employees, and around 50% attribute this challenge to ...
0
votes
1answer
49 views

How can I rewrite the sentence for technical writing style [closed]

I want to rewrite my sentence in technical writing style. Could you help me rewrite my sentence? Thank you in advance The proposed methods has 4 variables need to update in a optimization process, ...
0
votes
1answer
47 views

Requirements engineering: getting the most out of Word?

Are there any features in MS Word (ideally for Mac) that can be helpful in requirements gathering/tracing? As an example, at present I'm using comments in the Review pane to index requirements and ...
0
votes
3answers
42 views

academic writing: direct quote

I have a simple question regarding scientific quotes. Which of the following alternatives is correct? Alt. 1: The literature has made substantial strides towards identifying causal effects of X on Y ...
0
votes
2answers
63 views

Can you use et al. in a Bibliography?

In the text, I have, e.g. "...a major role to play in role-playing (Smith et al., 1990)." But can I use the same abbreviation in the bibliography? Smith, K. et al. 1990. Playing major roles ...
0
votes
1answer
34 views

Footnote placement — inside or outside terminal quote?

When you are referencing inforamtion in the footnote, is it customary to put the footnote number inside the quote or outside? For instance is it: "The pink pig."1 or: "The pink pig.1"
0
votes
1answer
48 views

How to cite a report in APA style

I have been trying to go through Mayfield Book on Technical Writing to find out how to do an in-text and parenthetical citation of a source that I found online. The source looks like a report with ...
0
votes
1answer
100 views

How to change Microsoft Word Heading style [closed]

For example, Heading 1 is automatically typeset as Chapter 1: Chapter 1 Title. I would like to change this to Chapter 1 - Chapter 1 Title however. How can I achieve this? I'm using Word 2013.
0
votes
1answer
33 views

Write a presentation of a dissertation [closed]

We have made a dissertation about a type of insect called Pine Processionary Moth. We have applied some statistical methods on it: data analysis and cluster analysis!! We have almost finished, but I ...
0
votes
1answer
118 views

Should this sentence be included in the Executive Summary?

I found some examples of good and poor example of executive summaries here. Everything seems fine but in one of them, they included this sentence - "All calculations can be found in the appendices"...
0
votes
1answer
115 views

website to publish article on high-performance cluster computing?

I am writing a tutorial-type article on high-performance cluster computing. It is aimed at researchers and grad students who want to use clusters to answer scientific questions, especially in the life ...
0
votes
0answers
28 views

How to set a punchy title for a book on popular subject [on hold]

After almost a decade of experience with C programming in the IT industry, I feel I can share with the world my experiences and write a good subject book on the C programming. However, there are ...
-1
votes
2answers
138 views

What help is there for a technical reseacher/writer that can't edit?

I've got a personal professional goal - I want to write a thesis, build a system, change the world. That's my way of saying that my thesis needs to be something I can develop into a functional system, ...
-1
votes
1answer
52 views

Are there any proper ways of using/implementing “e.g.” in a “Research Narrative”?

Are there any proper ways of using/implementing e.g. in a "Research Narrative"? I am working on a "Research Narrative" (I must write in both ALA and MLA format). I am curious about this e.g. but I ...
-1
votes
3answers
111 views

High Tech Audience

I have to write a simple introduction on the topic HTTP and its audience will be high tech. I am having a bit of problem in how to describe it in high tech audience? Can any one would suggest me how ...
-2
votes
2answers
98 views

Are there books to improve the style?

I've opened a question in another section: http://meta.programmers.stackexchange.com/questions/6911/is-this-question-possible-in-this-section The question is pretty unclear but for me is really hard ...
-2
votes
1answer
96 views

How to write “number of cups per user” for short using symbols?

I want to insert a text segment in a figure in my conference paper. Like "number of cups per user", can I use #cups/user ? I think "cups/user" means an average value, right? What I need is a X-Y ...