Tag: TechnicalWriting
Sorted by: Oldest Newest Active Popular Oldest
: 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
0 Reactions React
: How to use His/My/Your permutations in adressing persons 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
0 Reactions React
: Interesting and easier-to-read alternatives to the scientific academic article Short version: What is an equally informative, but more interesting alternative to typical academic-article-style scientific
0 Reactions React
: 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
0 Reactions React
: Does reading books help writing skills? Just what the title says. I decided to improve my writing skills only for blogging purposes (for starters and no, it's not a part of new year's resolution).
0 Reactions React
: Regarding Professional Report 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
0 Reactions React
: 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
0 Reactions React
: 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)
0 Reactions React
: How to write about things which depend on each other I am writing a technical documentation about a product. Now problem is there are many interrelated and interdependent concepts. I am just
0 Reactions React
: Is it legal to write about trademarked material and use the terms? I am contemplating writing a technical book (and probably self-publishing it) on a proprietary programming interface for a well-known
0 Reactions React
: How do you track dependencies for your co-authors? I and one or more co-authors, sometimes geographically distributed, are working on a set of related documents. Sometimes I will make a change
0 Reactions React
: Citing Myself As a Source I'm writing an academic paper on ethics in robotics. I have a previous paper that I wrote and would like to use material from it. If I use the material from
0 Reactions React
: How do you build good per-book *and* global indexes? For our SDK, we generate individual documents (PDFs) and one big HTML doc set (CHM file) from the same Docbook source. Each book has an
0 Reactions React
: Best practices for maintaining documented code examples? A good SDK (software development kit) includes plenty of well-documented examples. It also includes good tutorials and developer guides,
0 Reactions React
: Should I prefer long or short sentences in scientific writing? Currently, I am writing papers with rather short sentences: About half of them contain around 20 words, about 10% to 20% even less.
0 Reactions React
: What tense to use in an academic paper when speaking about correspondence? What is the correct tense to use in an academic paper when speaking about correspondence? Say one of my source materials
0 Reactions React
: Habits and routines for my first tech writing job A Japanese company has offered me a gig helping translate an Android1 business application + documentation into English. Their staff will do
0 Reactions React
: Is there a style / terminology guide for Android OS application documentation? This relates to my earlier question: Habits and routines for my first tech writing job I will be involved with
0 Reactions React
: How can a new writer make a realistic estimate of his work rate? This question relates to my earlier question Habits and routines for my first tech writing job which I was told to split into
0 Reactions React
: 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
0 Reactions React
: Where to find authors for highly technical articles? I've looked at some of the largest outsourcing sites. These have huge amounts of software developers, and huge amounts of casual writers.
0 Reactions React
: What is the best way to learn technical writing? I have a moderate level of skills in technical writing (TW) having gone through graduation in engineering. I was wondering what would be the
0 Reactions React
: Is it overkill to follow style-guides for technical writing? I currently work for an engineering company as an electrical engineer. A good chunk of my time is spent writing testing reports or
0 Reactions React
: Would it be weird if I write "a simple sample something"? Not getting too technical, I am writing a configuration file for a piece of software I have developed. This software allows others
0 Reactions React
: 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
0 Reactions React
: What would sections of a book that are larger than a chapter be called? I'm writing a technical book, and I want to split my book up into about 3 to 6 very broad sections, each of which
0 Reactions React
: How can you write less to say more? Sometimes you can write a lot without saying anything, sometimes you can say a lot but get little through the reader. In technical writing the later is
0 Reactions React
: 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
0 Reactions React
: How to leverage social proof? How can one use social proof as an argument without sounding like "just because everybody is doing it so should you"?. My problem is trying to demonstrate with
0 Reactions React
: Why are license agreements, disclaiming letters and others written with capital letters? We know that reading sentences with capital letters is hard. I noticed that some documents are still written
0 Reactions React
: In a "learn to do X" book, should a section review come before the quiz / exercises or after? I am writing a book on how to program in C#.NET. Each of the sections follows this format:
0 Reactions React
: What are "industry leading royalties"? In the breakdown description I received from a publisher, they mention that they also pay industry leading royalties of ##%. What does that mean?
0 Reactions React
: Writing a programming book: how to present directory structures What is good/preferred way of presenting directory trees in programming books? My main criteria are following: It should be readable
0 Reactions React
: 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
0 Reactions React
: What resources will teach me about the state of the art in technical writing? I've been asked to modernize some technical documentation - user manuals in particular. I have some guidelines,
0 Reactions React
: What is the word for the action of selecting an item by a mouse? I am writing a tutorial on how to use a specific web application and I don't know which verbs to use. Shall I use "click"
0 Reactions React
: Path to publishing a technical book I'm 21 years old female from South India. I would like to publish a book which concentrates on any one latest computer technology. Now, I have completed
0 Reactions React
: 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
0 Reactions React
: Is it okay to call the reader's target audience stupid? I'm a tech genre author, and have already published one book on Android development. However, this book was focused more on the developer
0 Reactions React
: 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).
0 Reactions React
Previous Page Next Page
Terms of Use Powered by ePowerPress Stock Market News!
© selfpublishingguru.com2024 All Rights reserved.