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

learn more… | top users | synonyms

-1
votes
3answers
68 views

High Tech Audience

I have to write a simple introduction on the topic HTTP and its audience will be high tech. I am having a bit of problem in how to describe it in high tech audience? Can any one would suggest me how ...
0
votes
1answer
16 views

DITA tag which contents are ignored or to contain non-DITA content [on hold]

Question: Is there, and what would it be, the right tag to enclose non-DITA content within a DITA document? The functionality that I am looking for is a tag, say <ignored></ignored> such ...
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?
0
votes
0answers
40 views

How to write polite follow up email? [closed]

I have written a mail to my senior developer, for which I haven't received any reply. I need to write a polite follow up Email. How I am supposed to address and ask him to look into the Email.
1
vote
1answer
22 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]. ...
2
votes
1answer
26 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
1answer
68 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
1answer
48 views

Plural of single letter variables

Excuse me if I am on the wrong StackExchange site. I write about Physics in English and typeset that with LaTeX. So I have a variable c, and there are two of them in the same expression. I want to ...
4
votes
2answers
78 views

Attracting and retaining volunteers to edit technical doc for open source projects

I volunteer as an editor for the Mozilla Developer Network (MDN), an organization that creates free open source software such as the Firefox browser. MDN has a large number of technical topics ...
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.)?
2
votes
3answers
421 views

Use of the Oxford comma

The oxford comma is the second comma in the sentence I like the colors red, white, and blue. Every grammar textbook I've ever seen, as well as the major style guides, feels that this is "proper" ...
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 ...
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 ...
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 ...
2
votes
2answers
43 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 ...
5
votes
1answer
69 views

Format keyboard keys in documents

I'm writing a guide to give step-by-step instructions to complete some tasks on the computer. At some points, I need to indicate pressing keys on the keyboard; how may I format the letter/symbol to ...
5
votes
2answers
64 views

How long is too long for a blog post?

I'm at the very beginning of a blog post for Worldbuilding Stack Exchange's blog, Universe Factory, written in conjunction with an answer to a question on Worldbuilding. It's going to about astronomy ...
2
votes
2answers
97 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 ...
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 ...
4
votes
3answers
75 views

How to work on a new software feature that affects different topics

We're working on a software manual with several chapters and topics and, so far, these are mostly self-contained. This means we have a dedicated chapter for "connectivity" and do not mention ...
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 ...
4
votes
5answers
337 views

How do I get rid of the tic of paired adjectives, predicates, etc.?

In technical writing, I have a tic of writing in pairs. Some examples from a recent piece: "When you speak, be sure to be clear and concise." "Face to face conversation is personal and private." ...
-1
votes
1answer
47 views

Are there any proper ways of using/implementing “e.g.” in a “Research Narrative”?

Are there any proper ways of using/implementing e.g. in a "Research Narrative"? I am working on a "Research Narrative" (I must write in both ALA and MLA format). I am curious about this e.g. but I ...
3
votes
1answer
167 views

Technical writing — best solutions for gathering and compiling data/information

Seek best solutions for information collection, compilation, aggregation Background I'm a newer technical writer working for an industrial fabrication company. We make an awesome B2B product that ...
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 ...
2
votes
3answers
119 views

How to find the balance between research and the obvious

I'm embarking on writing my first popular science book on a controversial subject. For sure the writing must be rational, coherent with a clear train of thought and littered with references to be ...
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
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 ...
6
votes
4answers
129 views

The fine line between accurate science, and confusing my reader

I recently wrote a blog post (original here) about a scientific study. At the end, I included some "fine print" which states, among other things: Correlation does not mean causation. It’s ...
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"
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 ...
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
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
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.
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?
2
votes
1answer
761 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
77 views

Graphical presentation method nomenclature

I'm part of a technical documentation team where I'm suggesting the document designers different methods for graphical presentation. Each time I need to talk about a method I have to look around and ...
3
votes
2answers
130 views

How to create a functional document for in-house reference?

I'm the only technical writer in my company with 2 years of experience. I have been assigned with a task of creating a functional document for a web-based (FMCG) product which has been around a long ...
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 ...
2
votes
2answers
39 views

Ethics of incorporating a supplier's technical documentation into one's own documentation?

A company, M, buys components from company, S, to build into their product. Company S has technical documentation regarding safety and maintenance available in many languages and publicly available in ...
3
votes
2answers
70 views

What's the common practice for warranty chapters in technical manuals?

I'm working on a technical manual project for industrial machines and the original documents have some warranty warnings and statements at the beginning. We decided to keep them on the new documents ...
1
vote
3answers
341 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
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, ...
4
votes
1answer
81 views

Writing a PhD thesis. Question about (an informal) introduction

I am preparing scientific thesis for the degree of PhD. It is a mathematical thesis. It is usually very difficult to tell your colleagues and friends what are the things you exactly work on with ...
2
votes
3answers
132 views

How to structure a sentence containing long code examples?

In the context of a technical manual, I need to write instructions guiding users through several standard manipulations. When providing examples of these manipulations, I have written a short sentence ...
2
votes
1answer
76 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
3answers
142 views

Ending a PhD thesis by saying “there is more to do”

I am ending the conclusion of my PhD thesis by saying something like this (not even remotely in these words): There was a lot of work gone in the thesis, yada yada yada, however there is room for ...