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

learn more… | top users | synonyms

6
votes
6answers
300 views

Book recommendations for writing better technical papers

My employer has presented me with two books to read to help me write better technical papers and emails. Essentials of English Grammar and Handbook of English Grammar and Usage. I have read through ...
5
votes
2answers
418 views

How do you introduce terms?

There's a few different styles for technical (academic) papers. Which is the preferred style to introducing new technical terms? For example, here is a paragraph I have that I don't like, because I ...
3
votes
1answer
5k views

What counts as a word when dealing with a word limit?

I am trying to determine if it will be feasible to revise a manuscript for a journal that has a 6500 word limit. Currently, the manuscript is between 7500 and 8000 words long, depending on how I count ...
2
votes
2answers
241 views

List of figures and diagrams?

I was wondering what is the most acceptable way of including a large diagram in my thesis. The diagram takes up a full page and splits a paragraph. In your opinion is this bad? Should I put the ...
6
votes
4answers
572 views

Which goes first: summary, background or justification?

I am trying to write a long expository piece and cannot figure out which information should come first. Here are three candidates: A summary/abstract lists the main points, without necessarily ...
3
votes
1answer
369 views

What is the style used in ISO/IEC publications?

I'm in the process of preparing a document to be sent to ISO/IEC WG14. What is the official style used in ISO/IEC publications (if there is one)? If there is no official style guide, is there a ...
5
votes
3answers
1k views
2
votes
3answers
325 views

Should Game Genre Types Be Capitalised?

I am currently writing a report for college about computer games and I am wondering whether genres need to be capitalised. Usually I do not but for some reason it just feels that I should. For ...
2
votes
1answer
99 views

Resources for thesis writing

Will be writing my master's thesis in a few months. I have never written a thesis yet though. I was unlucky enough not to be required to have a thesis during my undergrad years. Anybody know some good ...
1
vote
2answers
186 views

What free tools are there to help me improve my English?

I am in the process of writing a research paper in Computer Science. Are there any free tools/browser plugins/web sites/latex plugins that would help me improve my English? I am looking for some nice ...
9
votes
10answers
287 views

An alternative to saying 'users' when describing features

I'm creating some copy describing new web-app features for a number of different audiences (users, managers of sections of the site, owners of sub-sites which use our platform etc.). I'm finding ...
10
votes
5answers
4k views

How much time do you spend writing one page on average? [closed]

I'm writing a technical book about one programming technology and would like to compare how much time other authors spend on one page (on average). I rarely write a page and am done with it, quite ...
5
votes
3answers
318 views
8
votes
3answers
542 views

What are the key skills for a new technical writer?

For those that are just starting out, what are key skills they should have or learn to be a good technical writer?
5
votes
2answers
223 views

How can you build an interactive tone into articles?

I was wondering about tone in articles lately. My articles don't tend to be interactive. It feels like most of them are just flowing one way. How does actually tone contribute to the quality of an ...
3
votes
7answers
1k views

Verb tense for technical document titles

I'm writing a technical manual about creating database systems, and wondered what is the best verb tense for title names. My ideas are: Continuous (-ing) form: (e.g. "Creating a Cluster", "Creating ...
7
votes
8answers
538 views

Verbosity: when's enough enough?

In corporate life I've come across two general styles of writing: terse and cryptic or long and complete. In my own writing I tend to go too much in the "explain all possible interpretations" ...
2
votes
1answer
160 views

How should be the format for literature references that are websites (URLs)?

In technical writings are good established standards for formatting literature references. But that doesn't work this well for URLs. How should these references be formatted?