Tag: TechnicalWriting
Sorted by: Newest Newest Active Popular Oldest
: Where can I go to have my writing reviewed both in terms of style and technical content? I would love to have essays reviewed both in terms of quality writing and in terms of its content.
0 Reactions React
: How to link paragraphs in essays and articles? All I can find online is cohesion and coherence for paragraphs. But in a essay how can I link all the paragraphs. Any good methods for the university
0 Reactions React
: Is there any other way to share information on a website apart from typical Blogging, YouTube or Podcast? I have a website and I want to share content mostly related to security and technology
0 Reactions React
: Springer or CRC versus self-publishing I have an IT textbook that is about 120,000 words which was accepted for publishing at several very reputable publishers. My goal is to get the text out
0 Reactions React
: Computer science academic conference paper using "randvar" instead of "random variable" I am reviewing a computer science submission to an academic conference. The authors use "randvar" instead of
0 Reactions React
: Documenting framework features and descriptions We have written a custom software framework and it has grown to the point where we are ready for documentation. This documentation will be used
0 Reactions React
: Correct way of Citing References in a writing a Non-Fiction book? I am trying to write a non-fiction book about summarizing core computer science concepts. I plan to self publish this book through
0 Reactions React
: How to eliminate standoff between "Lengthy" vs "Concision"? Often while writing a software requirement/change-request documentation, I need to include the quoted requirements descriptively, the impacted
0 Reactions React
: Do writers need a business bank account? My question is simple: do writers need a business bank account? Or can they use a regular account for saving and declaring tax on their earnings?
0 Reactions React
: Technical specification for webservice (developers-oriented) - examples, methods & instruments Good time of the day, community! Hope, that my post won't irritate too much, but rather will be helpful
0 Reactions React
: Job description for my employment reference I've canceled my job to move on. Now I was asked how I want my Job description for my employment reference. My first draft was one full page...
0 Reactions React
: In scientific writing, what is the protocol for shortening nouns? I often see place or species names shortened in scientific journal articles and would like to know what the correct protocol
0 Reactions React
: What are some standards in naming a software/hardware version? I am wondering if how we name a version of a spacecraft differs from how we name a version of a software. For software, I usually
0 Reactions React
: Preferred word for "preferred", "target", "chosen" in end user support documentation I'm having trouble finding and sticking to one word to indicate whatever value the user intends to use with
0 Reactions React
: What are the indentation rules for the paragraph introducing a bulleted list? I'm writing a formal document for my company where it'll be shared and used by a number of teams. Unfortunately,
0 Reactions React
: When writing an error prompt, how do we tell the user the error happens in a specific tab? https://en.wikipedia.org/wiki/Tab_(interface) I have made a medical record application that allows someone
0 Reactions React
: When writing an error prompt, should we end the sentence with a exclamation mark or a dot? When writing an error prompt, should we end the sentence with a exclamation mark or a dot? I am
0 Reactions React
: Copyright related issue on publishing a technical book? I am preparing to publish a technical book on programming that contains figures and charts (like, compiler, linker, ASCII table, keywords
0 Reactions React
: Does software exist to easily markup technical documents as audio scripts? Inspired by this question: Is there a need for better software for writers? I have an IDE¹ related question about software
0 Reactions React
: What are the recommended sizes for a text box? If I am making a text box for an online document, how many characters should I leave for things like names and dates?
0 Reactions React
: What is a more techy Technical Writer job title that isn't cutesy or confusing? I have been hired as a Technical Writer at a firm who needed multiple types of writers: A few people were
0 Reactions React
: How should we plan for translations' space needs when designing diagrams that require text? Our documentation set includes some diagrams where text is integral and can't be handled in callouts,
0 Reactions React
: How can we make images with (necessary) text more translatable mechanically? Our documentation set includes some diagrams, such as entity relationship diagrams and flowcharts, where text is integral
0 Reactions React
: Plain language with long required phrases I am trying to create documentation for an application, and it's for end users who use keyboard (not mouse) and a screen reader. Some of our conventions
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
: Shortening a title without changing its meaning Essentially, I want to change: Managing a lot of people is a very difficult problem to: Lot of people, difficult problem I understand that
0 Reactions React
: For HTML documentation sets, are there meaningful guidelines for topic length? We produce a large HTML documentation set with the conventional two-pane view: expandable table of contents on the
0 Reactions React
: Is it ok to use long footnotes? In my text, I have a footnote (6 or 7 lines) that is meant to be an extra insight. It does seem, however, to be a bit large for a footnote. On the other
0 Reactions React
: What is special in API documentation compared to general technical writing? The title says it all: what is special in Application Programming Interface documentation compared to general technical
0 Reactions React
: Personal or impersonal in a technical resume In CVs or on Linkedin profiles there are often spaces dedicated to past experience. In those sections, one is supposed to describe what work he/she
0 Reactions React
: How to include external references when writing internal documentation? In the IT industry, we often write a lot of technical documentation meant for internal use only. Those documents are often
0 Reactions React
: Documenting software requirements As a self-taught developer the only requirement documents I've ever been privileged to read are those of hackerrank and the sort. However the more and more I
0 Reactions React
: What should go into a White Paper? I've heard the term "white paper" used in many situations. I've been asked before to write white papers on different subjects, though I've never successfully
0 Reactions React
: How do we write a good edit on Wikipedia? Is there a way to make sure that what we write sounds consistent with the style adopted by the majority of editors? I am not sure how people do
0 Reactions React
: Terminology in sociology & statistics What is the word commonly used in statistics when the thing that you want to measure cannot be (or was not) measured directly, so you assume that another
0 Reactions React
: What is in scope for criticizing technical writing I'm not well versed in technical writing. I'm probably not going to be in a position to give anyone feedback for some time, but I would like
0 Reactions React
: How to tag distinct options/entities without giving any an implicit priority or suggested order? An example of the problem in an aggravated form surrounds the controversy of France changing ‘mother’
0 Reactions React
: Is there any room in technical-writing for levity When doing technical writing it is generally advised to be straight to the point. And I understand that. After all if I am reading instructions
0 Reactions React
: Methods for writing a code review I currently spend a good deal of time over at Code Review and I would love to improve the quality of the reviews I write. Can you give me any insight into
0 Reactions React
: Strategies for writing software design documents I'm a self-taught programmer which means I started writing software by sitting down at an IDE and hammering out some code. When my decisions ultimately
0 Reactions React
Previous Page Next Page
Terms of Use Powered by ePowerPress Stock Market News!
© selfpublishingguru.com2024 All Rights reserved.