General Q&A about the craft of professional writing, editing, and publishing. Questions about all types of writing are welcome -- fiction, technical documentation, scholarly articles, poetry, scriptwriting, blogs, and more.
Filters (None)
A little context for my question... A long time a go, I started writing little vignettes for a character I was playing in an RPG group. The vignettes ended up joining up and becoming sort of a ba...
My character is using a hardly legible accent, or simply an accent which is not comfortable for a reader to read. For example: “Ye've caught us in th' middle o' supper. Seein' as how yer no bleedi...
I am thinking of starting a blog and wondering how I should approach it. Is it better to have a niche blog or is general/miscellaneous content fine?
What are the ways to practice and improve basic writing, like content and creative writing? I am not planning to write or learn to write fictional stories. By creative writing, I mean the essentia...
As technology and industry demands evolve, what tools/skills should one focus on learning/improving as a technical writer?
For projects with API documentation generated by Sphinx, I've noticed that some project's don't include links to the Parameter/Argument types (str, file-like object, int, etc) and some projects do....
Can someone please explain me the steps in writing a university assignment paper.
As a zipped web-page, EPUB has long offered the possibility of completely changing how a book looks and feels with dynamic content and interactive content. But since EPUB came out (2007), I really...
I've been working as a content writer and blogger for a few local agencies. I want to start freelancing this year but am slightly afraid to start. Could anyone help me how to start freelancing as a...
Question 1 Here I am asking about merely reading and writing. Do human readers take longer to distinguish between stems (and bases) that share the same root, even if merely picoseconds? For exa...
We publish documentation online using HTML. For things like fixed parameter names and other code literals, we use <code> tags. My question is about styling these in tables. On our referenc...
Shorter sentences have been proven more readable. Thus why didn't the authors below sunder their lengthy sentences, prolongated by commas and (semi)colons? Why not divide them into shorter sentence...
Shorter sentences have been proven more readable. Thus why didn't the authors below sunder their lengthy sentences, prolongated by comma + conjunction? Why not divide them into shorter sentences s...
I am often in the situation where I would like to cite a source in another language, and as such include my own translation alongside the quotation. I have been told that translation is a form of ...
Over on the Judaism site, I summarized a narrative text in a block quotation. Because the narrative is well-known, I expected many people to skip the block quotation; therefore, I did not want it t...
"A garden path sentence is a grammatically correct sentence that starts in such a way that a reader's most likely interpretation will be incorrect; the reader is lured into a parse that turns out t...
This post is about Q&A websites in general. In StackExchange there is a culture of closing questions which do not reflect "the standards"; it's a culture that I as someone who uses SE since 20...
We produce a large HTML documentation set with the conventional two-pane view: expandable table of contents on the left, selected topic on the right. When you select a topic, if it has subtopics --...
We publish a substantial documentation set online. Each page has a place at the bottom that asks "was this helpful? (Y/N)", and if the person chooses "no" we offer a textbox. We collect all this ...
I am going to be writing some user-facing documentation for a database that visitors can query. That is, the people writing queries are not the ones who created the database; they can come in, look...
I am documenting features on a web site. The audience is end users, who could be anywhere from seasoned Internet veterans to relatively new people who came for my site's content but aren't general...
In this article about different categories of heroes, Matt Bird states that sensitive and unlucky heroes are hard to write because audiences have a hard time caring about them. He says: "Americans...
The Hugo awards are prominent fan awards in the SF&F genre. In 2021, I noticed that all of the finalists in the Novella category are from a single publisher, Tor.com. Novellas have, I underst...
I've always struggled writing about myself, but I need to apply for a program and the application has a lot of very broad but personal questions like, Tell us why you would be a good leader Exp...
When referring to a paper with multiple authors by using the name of the first author and "et al.", how does one indicate possession? For example, is it correct to write, "Einstein et al.'s paper ...
We use Madcap Flare for our documentation, and it has an annoying property: if you happen to have the shift key down when you type a space, it inserts a non-breaking space ( ). Our docume...
Are there any other "times" for introducing new content into a final paragraph? Have any other famous writers substantiate this bombshell? I was flabbergasted to read this para. because mo...
I don't understand the example emboldened below. Can't you add just a superscript number in the text, then in the footnotes cite that "minor case"? Unquestionably one superscript cannot "detract fr...
We use Madcap Flare for our documentation, and the project is checked into git. (In case this matters, this is a locally-hosted git server, not GitHub.) The project uses a .gitignore file to aver...
I joined my current company and department a few years ago. We had some documentation for processes but most people had been around for a long time and never needed it, so it was very sparse. Sinc...
Hey, I'm having trouble editing my book. I have a crime novella but I can't edit that well. Does anyone have any tips to help? Thanks! ~Rosewood
In our documentation of SQL functions and statements, we include a BNF-style syntax summary. As is conventional, we indicate optional elements in square brackets, like this: CREATE [IF NOT EXISTS]...
Our software documentation set (for a SQL analytics database platform) is large, because SQL and databases have many pieces. Often a single statement, function, or feature will be highly related to...
Our documentation set includes some diagrams, such as entity relationship diagrams and flowcharts, where text is integral and cannot reasonably be handled in callouts. Our documentation is translat...
We use Madcap Flare for a large documentation set, with HTML output. (Flare source is a very HTML-y XML with some Flare-specific additions.) We use git for source control and new work is done on ...
I was putting together an instruction page (for setting up a game that my business created), which included a whole lot of various pointers, most of which were only a sentence or two long. These ex...
This answer discusses how to choose between traditional print publishing, ebook publishing, self publishing, etc., and concludes by stating that You should publish your book using the channel wher...
I've recently begun investigating the publishing process, and what I as an author need to do to get my book read. I'm aware of the self-publishing option, but as I have not studied any options exte...
Two characters (one is a PoV character) come up with a plan to break a third out of prison. They succeed, with only minor complications. If I describe too many details of their plan beforehand, it ...
I have a blog with long, analytic articles. Because of their nature, they don't really attract much clicks. However, once people distill it thoroughly, many of them express that the articles are in...
In a story I'm working on, at one point one of the main characters (also the POV character in this case) arrives at a new location which he has never been in before. This is the first mention of th...
Sometimes, when I write, I find myself writing down a path that ends up not leading at all where I wanted to go with what I was writing. That's to be expected when discovery-writing. Depending on t...
We use Madcap Flare to produce a large documentation set that contains many code examples (primarily SQL, but also C++, Java, and Python) and command-line operations. When the doc set was first pl...
A good SDK (software development kit) includes plenty of well-documented examples. It also includes good tutorials and developer guides, which introduce concepts in logical progressions, typically ...
I have a character which is typical street thug, criminal and did his time in jail. He is using a lot of underground Argot and thug slang. Example below At the end we got the ice, gravy train if y...
Recently, I threw together a draft of a policy page about promotional content, with some guidelines on what to keep in mind to avoid spamming. (Incidentally, this is for Codidact itself.) I decided...
In my latest short story I'm playing around with common gender misconceptions. It's set in a near future society were men have disappeared, and all roles are taken up by women. The theme is played ...
Over the years I gained small audience and I love them. My last work quite disappoint them in regard of one character and I feel bad about it. I felt like character's struggle she went through woul...
For some reason, when I find myself writing a male protagonist, I seem to default to the brooding, gritty kind of man that could easily find his place into a noir novel. Those characters are often ...
I am using, for action scenes, this three act format which allows me to control pacing and create order in hectic environment: Action - analysis - reaction Johann fired (action) his pistol and mi...
