Tag: TechnicalWriting
Sorted by: Newest Newest Active Popular Oldest
: How to know you are over-explaining and oversimplifying a subject? Recently, I started writing articles about different subjects I learn on my own (programming, logic ...etc). While writing, I
0 Reactions React
: Spell out numbers before times, days, months? The general rule I follow is to spell out numbers < 10. Also when use numbers before measurement I don't spell out. For example: I bought nine
0 Reactions React
: What's the correct way to write 3 x 10^6 (three million)? I am reviewing some research reports and found myself diving into the black hole of technical writing style. My question is what
0 Reactions React
: Sentence starters for summaries? I'm writing a technical book (step-by-step sort of book) and noticed that all my summaries start with 'In this chapter we ...'. What would be some other sentence
0 Reactions React
: Dots in lists with mixed-width items It is common to omit end-dots in lists with very short items: Shop list: * Milk * Bread * Probably eggs It is common to use end-dots in lists with long
0 Reactions React
: Permission to use open source data I am working on a technical book teaching users how to analyse data using geographic information systems. I would like to use data from an open source data
0 Reactions React
: How can I get a technical writing job for software apps without a degree? I have no degree and I cannot afford to have one, however, I would really love to get into technical writing because
0 Reactions React
: How can I mention errors in the data that I received in my thesis? Where to mention it? I received data for data analysis for my Bachelor-Thesis. I still got 4 weeks left to finish the 40
0 Reactions React
: Comparing writing style and clarity of instructional language Background: I am comparing a historic set of procedural instructions for the same action see mini-corpus below (1770-now). I have noticed
0 Reactions React
: Difference between DITA and S1000D I'm trying to understand the technical difference between DITA and S1000D. Yes, I know, the common wisdom is that if you need documentation for helicopter or
0 Reactions React
: Topic-based authoring vs. Modular authoring What is the difference between "topic-based authoring" and "modular authoring"? As I know, there are two well-known authoring approaches: Narrative authoring;
0 Reactions React
: I have a retracted article for ethical misconduct, this means my career is over? When I was in my first year of M.SC. A professor told me to work on a project that the main data were belong
0 Reactions React
: How do I insert programming code snippets within Scrivener? I'm trying out Scrivener, as I intend to write some technical material. I'm a Software Developer and what I intend to write is programming
0 Reactions React
: How could I improve my article writing? I am a teenager and would like to know more about article writing. I was to write some articles someday. Should I be casual or formal? What POV should
0 Reactions React
: Repository of My Academic Writing - Which License to Use? I'm adding a repository containing selected academic papers I wrote. I'd like to add a license to this repository that works similarly
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
: How can you start writing multi-author collaborative book? We are a group of people who want to write collaborative a book, but since we are based in different locations, how can we go on
0 Reactions React
: How to present an alternative without being negative about the other option? Good day, I have the following sentence: Nowadays to reach the mass audience, you don't have to rely on traditional
0 Reactions React
: Is there a definition for formatting plain text documents like they are on TLDP.org? Is there a formal specification for authoring plain text documents like they (mostly) are on http://www.tldp.org/HOWTO/text/?
0 Reactions React
: Case study headings I'm going to be preparing several case studies for my company and I'm pondering what patterns to use for headings—both the case study title and headings within a case study.
0 Reactions React
: Rewriting User Guides as Stories I'm increasingly having to write User Guides as part of my job and I need routes to make this into a more interesting exercise. Hence, I was actually looking
0 Reactions React
: Where do I start with C++ documentation? I am new to programming and am entirely self-taught. I have reached a point in my writing where a solid grasp of documentation standards would be greatly
0 Reactions React
: What are alternatives to "is that" as in "[something] is that [something]"? I am writing a thesis and I frequently find my self using the phrase 'is that'. For example: "The other feature that
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
: Technical review process when using FrameMaker I'm an engineer. At my company, engineers seem to spend a lot of time reviewing technical documentation written by people who work in different
0 Reactions React
: Should creativity or eloquence in a technical document be removed during review? I am working on churning out some technical documents, which are similar to a colleague's. I've copied some sections
0 Reactions React
: Putting code examples in BSC thesis I am writing my bachelor's thesis in software engineering. It is split into two parts: a theoretical part where I analyze existing literature, compare models
0 Reactions React
: What language should I write my programming blog post in? My background I'm a native French speaker and a software engineer, I studied in French and grew up speaking French. My Question is: which
0 Reactions React
: What is the best way to take a theorem from another paper? I would like to include a theorem from a paper, say Alice et al. [12], in my own manuscript. Which option is the most readable
0 Reactions React
: What's the best way to write (or rewrite) a math book? I've been writing a book that has a fair share of geometric diagrams and equations. However, I am unable to make use of a computer
0 Reactions React
: Is it necessary to always write a prefix to indicate a Part Number in technical writing? I'm wondering if there is an accepted way to prefix part numbers in technical writing. What I have
0 Reactions React
: Best alternate sentence for 'Please let me know if any questions/comments' I feel bored to have this in my all mails 'Please let me know if any questions/comments', any best alternate sentence
0 Reactions React
: How can I make a case for toning down the "rah rah" marketing tone around technical content? Summary Starting from the position that -- with modern web delivery -- the line between technical
0 Reactions React
: Should the documentation of a known issue change dependent on the stability of a product release? I am writing the release documentation for a software product and a design flaw has been discovered
0 Reactions React
: How should I document a product release with an inherently flawed design? The deadline is looming and someone realizes the product can't be shipped without documentation. Once the product leaves
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
: What is the difference between "accurate" information in a document and "believable" information? As part of some research I am doing on measuring documentation quality, I have come across the
0 Reactions React
: How to effectively document a product composed of complex microservices? I have a highly flexible software product consisting of a series of loosely coupled microservices. Each component is effective
0 Reactions React
: Have there been any studies indicating which software documentation practices save the most time during onboarding? It's generally conceded that at least some documentation saves people time when
0 Reactions React
: How does web page writing differ from blog and article writing? Yesterday I was talking with a client and he asked me to write web page content. I told him that I can write blogs and articles.
0 Reactions React
Previous Page Next Page
Terms of Use Powered by ePowerPress Stock Market News!
© selfpublishingguru.com2024 All Rights reserved.