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

learn more… | top users | synonyms

1
vote
1answer
38 views

How do I build a better blog website? [closed]

I've spent the last few days building a website that I want to use a showcase for my written work, and as a personal blog. What fundamental changes should I make to improve a viewer's experience? The ...
1
vote
1answer
39 views

Author order and grouping on technical document

This question pertains to author/contributor order and grouping on a technical document. I performed tests on some equipment and had two other people directly involved. My boss and his boss need to ...
1
vote
2answers
258 views

To translate a novel with Westerner's point of view

I am an Easterner. I have been translating a novel, that is originally written in my native language, into English. During the process, I have also been learning about cultural things, meant to ...
1
vote
1answer
60 views

Numeral Citation Scripts

I am writing a report in Farsi and using ieeetr bibliography style for my references. This style uses numeral references like [1] [2] etc but regarding context (Farsi) I am using Arabic number scripts ...
1
vote
0answers
26 views

What is Content Testing?

What is Content Testing? Are there content testing tools available or they are simply tested manually for quality.
1
vote
1answer
125 views

How much detail is considered enough for literature review of a research paper

I and a few of my friends are conducting a small research project to determine the prevalence of hypertension, where we live. I was hoping I could get an opinion on how to write our literature ...
1
vote
0answers
134 views

Using the Minto Pyramid

Using the Minto Pyramid, should I order the paragraphs of my paper by going through the rows of the pyramid like this? Thesis > Why > How > Where > A > B > C > D > E Or should I start at the top ...
1
vote
3answers
1k views

Where should index and glossary appear in a report?

I am writing my thesis and now wonder whether I should typeset index and glossary as an appendix or after them. There's no department-level accepted writing style, so my adviser's opinion might be ...
1
vote
0answers
59 views

Regarding Professional Report [closed]

I am new in the working world and I happen to be given a lot of tasks related with creating report. Later on I heard people give me comments that my sentence structure and my word choices are not ...
0
votes
2answers
132 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
216 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
65 views

How should I handle repeating parts in a technical description?

I'm about to write a technical description for an industrial process. The description will follow logical blocks, or blocks from the PFD of the process. This a sales document aimed at engineers. ...
0
votes
1answer
84 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
584 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
58 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 ...
0
votes
1answer
32 views

Write a presentation of a dissertation [closed]

we have made a dissertation about a type of insect called Pine Processionary Moth. we have upplied some statistical methods on it: data analysis and cluster analysis!! we have almost finished, but i ...
0
votes
2answers
304 views

Looking for sites that describe minimalist writing for technical content

I'm looking for a site or sites that describe minimalist writing (http://en.wikipedia.org/wiki/Minimalism_(technical_communication)). The Wikipedia article is so minimalist it doesn't provide such ...
0
votes
1answer
112 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 ...
0
votes
1answer
109 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
5answers
209 views

Struggling to writing in English

I always struggle to write my ideas in English. Structuring my work/idea when it comes to writing leaves me blank. Even when I'm very clear about what I want to write, I will still struggle with ...
-1
votes
2answers
129 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, ...
-2
votes
2answers
85 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
75 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 ...