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

learn more… | top users | synonyms

2
votes
2answers
8k views

Multiple authors in MLA header

I'm writing a group paper and I was wondering whether there's a correct way to list multiple authors at the top of the first page in MLA format. Normally the header would look something like: My Name ...
2
votes
2answers
93 views

How to represent dependencies in outlines

The bulk of my writing consists of technical papers, reports, notes, and memos. Because of the mathematical nature of my work I spend a lot of time writing definitions, and it is very important that I ...
2
votes
2answers
60 views

How does one avoid incomplete changes to documentation?

Having encountered errors in technical documentation that almost certainly came from incomplete editing after copying from earlier documentation, I am curious about what techniques can be used to ...
2
votes
2answers
97 views

When is a screen shot really useful in training documentation?

Software products evolve more rapidly each day. Technical documentation for those products must also follow their evolution. One of the biggest challenges is to maintain screen shots when the ...
2
votes
1answer
1k views

Mashery vs. Apigee

I was wondering if anyone could lend some advice as to the pros and cons between using Mashery versus Apigee for documenting an API? I have do some evaluating and have about 2 weeks to come up with a ...
2
votes
3answers
78 views

Introducing the next sub-section or not?

I am writing my phd dissertation in a technical field and I have a question. When in the same chapter, I finish a section and want to connect it with the next section I am not sure what is better. ...
2
votes
0answers
65 views

How to use His/My/Your permutations in adressing persons [closed]

I'd like to understand the rationale of when, why and how His/My/Your are used in titles of addressing people. For example, the standard commonly accepted uses are: "His Honour"("His Grace", or ...
1
vote
4answers
119 views

Is this description of my small productivity application clear enough?

I wrote a small productivity application, Tomate. Since I'm not a native English speaker, I'm afraid the description of the project may not be clear enough for potential users. Can you help me improve ...
1
vote
4answers
133 views

How can I express this more clearly or concisely?

I'm documenting a block of computer code and would like to make it clear and concise. I'm describing a function that populates a field on a user input screen. Here's my best shot but it still seems ...
1
vote
3answers
138 views

How do I use my blog as a platform for practice and improvement?

I've recently followed the advice of our very own Jeff Atwood and started a blog site in order to become a better writer and communicator. My goal is to improve my skill at technical writing and ...
1
vote
1answer
180 views

What are best practices when writing technical descriptions?

Occasionally, in my job as an engineer, I write process descriptions of the technology we are selling. Those are part of commercial offers, intended to win the customer. Those are bundled with ...
1
vote
1answer
72 views

Multiple tasks and a step by step tutorial

To my knowledge step-by-step tutorials should have the form of a ladder, where you describe how to get to a place step by step– accomplishing a single task at the end. Is it possible to accomplish ...
1
vote
2answers
164 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 ...
1
vote
1answer
201 views

Using Glossary Instead of Footnotes (for translation/transliteration)

I am writing a technical report with keywords which are mainly English. I am using a Glossary at the end, which describes translated keywords. Is it a replacement for footnotes or I should just keep ...
1
vote
3answers
267 views

How can I manage screen shots and other graphics for maintenance?

Our ~1500-page documentation set contains numerous screen shots and related graphics (schematics, flow diagrams, etc). Sometimes the user interface changes and we have to update all the affected ...
1
vote
1answer
147 views

combining sentences

I want to say couple of this within one sentence. so my sub sentences would be: We removed the vertical features from the classification process. The removal of vertical features enhances ...
1
vote
4answers
123 views

What are the tool choices for producing technical documentation in PDF and web site ready HTML?

My company currently maintains our technical documentation (User's Guide) in Google Docs. With each release I produce a PDF that we host on our website. Here are the features of Google Docs that work ...
1
vote
2answers
250 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
58 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
1answer
25 views

When should I use italics in scientific writing?

I noticed that proper nouns, such as names of theorems or techniques are often set in italics in scientific writing but not always. Are there rules about it, for example each proper noun should be set ...
1
vote
0answers
94 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
114 views

The Best Title for my Skill Set [closed]

I'm about to branch off into the freelance world. I'm starting an LLC and I'd like some input on what I should title myself as the owner. For example "creative specialist" or "creative technician" or ...
1
vote
3answers
796 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
58 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
120 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
150 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
51 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
82 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
3answers
122 views

Risk Assessment in Technical Standards Documentation

In your experience, are sections on risk and risk management typically part of technical standards documentation? For example, in a document that describes how the Network Time Protocol is ...
0
votes
2answers
55 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
447 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
1answer
57 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
105 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
102 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
14 views

Framemaker/ Software Question [migrated]

I have just started documenting a purchasing/warehousing/billing/sales/accounting application - a real monster! It is being deployed to multiple sites and is modified for each site. This means the UI ...
0
votes
5answers
118 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
126 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, ...