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
179 views

Metrics for assessing the persuasiveness of a paper?

Are there any known variables to measure, or questions to ask in survey, in order to asses the persuasiveness of a paper? For example, I'm not sure if omitting a section from my paper might actually ...
2
votes
1answer
129 views

How to combine a visual and textual outline

I am a Ph.D. student in engineering, so most of my writing fits into a fairly strict idiom: the IMRaD (Introduction, Methodology, Results, and Discussion). In general, I like to use an outline to help ...
2
votes
1answer
3k views

APA (sixth edition) citation for the Fourth Assessment Report

I'm trying to cite a source from the IPCC Fourth Assessment Report: http://www.ipcc.ch/publications_and_data/publications_and_data_reports.shtml I'm fairly new to APA in general and I'm struggling to ...
2
votes
1answer
166 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?
2
votes
1answer
33 views

Should I use figure titles for diagrams on the web?

Should I use figure titles for diagrams in web content if the diagram already has a caption? Guidance or references are appreciated. The context is a marketing page whose basic structure is shown in ...
2
votes
2answers
104 views

Authoring tool for interactive documentations

I am searching for an application (Desktop- or Web-App) to write and create interactive documentation (especially technical documentation). I like Madcap Flare for technical writing, but I'm looking ...
2
votes
1answer
89 views

Is the Microsoft Manual of Style appropriate for writing general IT related instructional documents?

I'm currently working for a company's IT department, and one of my tasks is to write documentation for common procedures that we perform, in order to get new employees acquainted with them more ...
2
votes
1answer
209 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 ...
2
votes
3answers
39 views

How to move back to main section after done writing a sub-section

I am writing a paper but I don't know how to move back to main section after done writing a sub-section, like this 1.1 Main section 1.1.1 sub section 1 1.1.2 sub section 2 but as I write long sub ...
2
votes
1answer
85 views

Ways to influence the readers subconscious?

Are there any proven techniques of influencing the readers on a subconscious level? Preferably techniques involving only words as I'm interested in writing technical books and I don't have the liberty ...
2
votes
2answers
52 views

Wording of comparing X vs Y and X vs Z but not X vs Y vs Z

As per the title I compared my system against two other systems separately but I'm worried about it coming across as that it was a three way comparison. Neither of the below titles convey what I want ...
2
votes
1answer
1k views

What is Content Testing?

What is Content Testing? Are there content testing tools available, or is content simply tested manually for quality?
2
votes
1answer
47 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 ...
2
votes
5answers
297 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 ...
2
votes
3answers
84 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
1answer
69 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
1answer
287 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 of ...
2
votes
0answers
69 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
501 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
122 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
131 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
514 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
153 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
203 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 Addition,...
1
vote
3answers
169 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
2answers
199 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
103 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
86 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
2answers
81 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. ...
1
vote
3answers
194 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
1answer
81 views

How to structure the text when describing the steps of a procedure which has simultaneous processes?

I have to further explain my intent here. I'm writing down some procedures in operating manuals and servicing manuals. I mostly use numbered lists and sometimes just bulleted lists. Recently I started ...
1
vote
1answer
30 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
110 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
2answers
630 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 ...
1
vote
1answer
164 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
44 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
52 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
78 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
10 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
78 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
343 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
127 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
45 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
2answers
267 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
63 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
3answers
52 views

How do you write a good product description? [closed]

Are there any rules or procedure to write a great product description. Any examples of good desciptions online?
1
vote
1answer
91 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
315 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 review....
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
61 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 ...