Tag: TechnicalWriting
Sorted by: Popular Newest Active Popular Oldest
: What's the modern way to handle gender in tech writing? Back in my day, I was taught to use masculine pronouns. The user chooses a password, and then he types it in the text box.
0 Reactions React
: Does a technical writer need a technical background? Does a technical writer need a technical background?
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
: Can basic grammar rules be skipped when writing text for machine safety labels? First of all I'm completely against this idea but a few people who contribute to the technical documentation project
0 Reactions React
: What's the least distracting method to inform editors I'm a woman? I have a gender-neutral name, so people often assume I'm a man. However, a portion of the writing I do is for tech companies.
0 Reactions React
: Can technical writing suck less I currently have the prospect of writing a considerable amount of technical documentation (describing interactions with an extremely complex online service). I consider
0 Reactions React
: An alternative to saying 'users' when describing features I'm creating some copy describing new web-app features for a number of different audiences (users, managers of sections of the site, owners
0 Reactions React
: How can one make technical issues more accessible to a non-technical audience? Most of what I write is non-fiction -- technical books, blog posts on open source topics, political stuff, etc.
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
: Technical Writing Software I'm interested in newer software/software stack to use in writing technical papers. For the longest time I have been use LaTeX to handle this but in looking at getting
0 Reactions React
: How can I improve my sentence construction or flow in general writing? Can anyone suggest resources or techniques I can use to improve my sentence construction when writing? I am a native English
0 Reactions React
: Should one use the legal "shall" in requirements documents and specification documents? At least in the US, "will" has replaced "shall" in most every context, with the notable exception of the
0 Reactions React
: Verb tense for technical document titles I'm writing a technical manual about creating database systems, and wondered what is the best verb tense for title names. My ideas are: Continuous (-ing)
0 Reactions React
: How can I stop overusing "I" in my writing? I won't edit this question, so you can see how much I use it. The current count is 3 times. I've been told that the solution is to revise, revise,
0 Reactions React
: Verbosity: when's enough enough? In corporate life I've come across two general styles of writing: terse and cryptic or long and complete. In my own writing I tend to go too much in the
0 Reactions React
: Good Outlining Solutions For OSX? I write technical non-fiction and find that I cannot write well without first constructing a detailed (10-20 page) outline. Are there any good outlining solutions
0 Reactions React
: What are standard techniques that indicate to the documentation reader that they are to substitute their own appropriate text (e.g. username, domain)? When reading manuals or guides, I can easily
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 software product release notes be in marketing voice or technical voice? (software documentation) Typically, the voice of marketing content doesn't match the voice of technical content --
0 Reactions React
: Is there a hemisphere-neutral way of specifying a season? I want to refer to the timeframe of Summer 2019 in the Northern hemisphere. However, the writing is intended for a global audience,
0 Reactions React
: Will I ever be able to write like a native writer? So a little while ago someone said that I'll never be able to write on a native level because I wasn't born in the UK or America. I
0 Reactions React
: How do you explain the details of something technical to a non-technical audience? When writing about technical topics it is often difficult to get across the complexity of a topic without getting
0 Reactions React
: Quality of my blog writing I came here from Jeff Atwood's blog where he mentions that writing a blog can clear your own internal thought processes and that you should take feedback about your
0 Reactions React
: Writing first programming book I was recently asked if I was interested in writing a book for a pretty reputable publisher, which of course I accepted. I am not a writer by trade, I am a
0 Reactions React
: Book recommendations for writing better technical papers My employer has presented me with two books to read to help me write better technical papers and emails. Essentials of English Grammar
0 Reactions React
: Ways to improve your writing skills As a CS major I've learned that knowing how to write is critically important, but, I'm not really sure how to improve my writing skills. I'm currently trying
0 Reactions React
: Demo data in screenshots! What are the best practice? My question is related to best practices of making screenshots for end-user documentation. Particularly, is there universal information for
0 Reactions React
: Overusing "the" and "I" I'm not a native English speaker, and I find that my English writing contains too many definite article "the" when writing scientific reports, and too many "I" when writing
0 Reactions React
: Does this feel like natural English? Although I'm pretty confident in my English, I'm not a native English speaker. I need to write a short introduction for a symposium; I'd like to know if
0 Reactions React
: When is a screenshot really useful in training documentation? Software products evolve more rapidly each day. Technical documentation for those products must also follow their evolution. One of
0 Reactions React
: How much humour is effective in technical documentation? It's well known that live presenters are often advised to add a dose of humour in order to engage the audience better. However, I very
0 Reactions React
: Using uncommon abbreviations Something which I see all the time in (popular) science writing is the use of abbreviations to indicate concepts. For (a made up) example: So when we're dealing
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
: 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
: 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
: 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
: What are the advantages of different date formats in resumes and CVs? I've seen a somewhat related question, but it doesn't answer my question quite right. Say you're writing an event that happened
0 Reactions React
: 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
0 Reactions React
: 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
0 Reactions React
: 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
0 Reactions React
Next Page
Terms of Use Powered by ePowerPress Stock Market News!
© selfpublishingguru.com2024 All Rights reserved.