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

learn more… | top users | synonyms

9
votes
10answers
286 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
3k 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
314 views
8
votes
3answers
527 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
221 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 ...
2
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
519 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
156 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?