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

learn more… | top users | synonyms

2
votes
1answer
43 views

How to reference an ISO/IEC?

I'm doing some college work and I'm using ISO/IEC 27000 Information technology — Security techniques — Information security management systems — Overview and vocabulary. In Word, I have set up the ...
2
votes
0answers
68 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
5answers
393 views

What's the best text editor for a technical reference manual?

It is my first time writing tech manuals and I don't know what to use. Some people recommend me LATEX but I think it's too complex. I basically need a text editor that let me: Type latin characters ...
1
vote
5answers
110 views

technical subjects - non-fiction vs fiction

This is a question I tried to ask in Novelizing non-fiction, is it worth it? But was un-clear and maybe too generic. Let’s say I am a scuba diving expert and I could write a non-fiction book about ...
1
vote
4answers
128 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
3answers
340 views

Technical Documentation Voice Preference : “Active Voice” - “Passive Voice” - A Mixture of both

We are working on a technical documentation project which includes the rewriting, modernization, restructuring, enrichment of the content. I'm doing the content rewriting and translation parts of the ...
1
vote
4answers
151 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
4answers
188 views

How to indicate the topic has been changed without using words?

I am writing an an article to share knowledge, not novel. Usually, when you change the current topic, at the beginning of the new paragraph you would like to use some transition words such as ...
1
vote
3answers
165 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
78 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
196 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
2answers
89 views

How I should handle gender-neutral pronoun in technical writing? [duplicate]

I am writing API documentation for a mobile loyalty program and I am not sure which of the following is better wording: 1) When the user requests for their visit and order to be registered in their ...
1
vote
1answer
85 views

Relative clause or a new sentence. Which is better in an introductory paragraph?

I wrote In our approach, we rely mainly on the page's content to detect a data region, which in our definition is comprised of a node or a range of nodes in the DOM tree, constituting a ...
1
vote
3answers
184 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 ...
1
vote
3answers
320 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
3answers
69 views

What is considered an acceptable length for a technical document?

I have written dozens of technical and requirement specifications, and edited dozens more in 8+ years of engineering. The largest I have drafted was perhaps 100 pages, but maybe 30-50% of it was ...
1
vote
1answer
27 views

Is it necessary to explain what is written in upcoming chapters?

When writing a technical report, is it necessary to explain what is written in upcoming chapters? For example in my introduction chapter, I may have a sub-chapter called "Forthcoming chapters" which ...
1
vote
1answer
82 views

Order of names in title

I and two other students are writing a proposal to a corporation to donate some equipment to the Electrical Engineering department at my school. When I put our names under the title of the proposal, ...
1
vote
1answer
176 views

Copyright of examples used in books?

I'm getting into non-fiction technical writing (a blog, but potentially ebook or otherwise). Often the best technical advice come from dissecting and synthesising good and bad examples from the ...
1
vote
1answer
162 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
1answer
21 views

should I put the reference number after the dot or after a space? [duplicate]

I am writing my thesis. and I need to know the correct way of putting the reference. for example: this is a sentence taken from someone [2]. this is a sentence taken from someone[2]. ...
1
vote
1answer
46 views

Concepts for more interesting Introductions in Papers

What are the key concepts for writing introduction text more interesting to the reader? An example: The Deutsche Bahn AG is the company with the most energy consumption in Germany. It has ...
1
vote
1answer
58 views

How can I avoid using the first person in a report when directly referring to work and experiences I have had?

I have been asked to write a report on the company I am working at during a placement from University (I am on an engineering programme). There was not much guidance given on what the content of the ...
1
vote
1answer
7 views

APA Headings- Frequency

How often should you use a heading? Are there any guidelines or limitations to using headings too often (i.e., every paragraph, every other paragraph, etc.)?
1
vote
2answers
72 views

Report writing: should I use ® © symbols?

I am busy writing a report for university. For this, I did some programming in MATLAB and simulations in Aspen Plus and HYSYS. When referring to these software in the report, should I symbols such ...
1
vote
1answer
150 views

Should I write “what do the data show” or “what does the data show”? [closed]

I wonder what the proper way of writing this question is: What do the data show? What does the data show?
1
vote
3answers
119 views

Technical writer degree with an English BA?

I'm desperately trying to get out of my dead end Federal job. I have a BA in English and a love of a lot of different topics, including several science fields. I would have Majored in science if I ...
1
vote
1answer
43 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
46 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
264 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
62 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
29 views

How do you write a good product description?

Are there any rules or procedure to write a great product description. Any examples of good desciptions online?
1
vote
1answer
70 views

Citing an article with multiple authors 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 is an article from a popular ...
1
vote
1answer
280 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
161 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
2k 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
60 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 ...
1
vote
5answers
267 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 ...
0
votes
2answers
162 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
267 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
75 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
198 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
92 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
694 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 ...
0
votes
3answers
41 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
53 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
31 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
38 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
80 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.