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)
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...
When documenting software API so others know how to access the various methods, what data structures are used etc, I like to document each bit in detail and also include, regardless of the coding l...
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...
Even though discovery writing is about letting the story go without interference, you still don't want the characters to get killed in the first chapter. For this exists safety nets, people, objec...
So my fears are kind of taking over my enjoyment of writing my book because I feel I'm doing something wrong. In my story I stole ideas from other stories. I took the idea of Bioshock's infinite so...
I was asked to prepare an overview of an existing IT architechture and provide a document that consists of weaknesses analysis and suggestions on how each of the weak spots can be improved. How to...
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...
I have enjoyed writing prose for years and have a few short stories penned. I would like to build up to a novel but believe I have identified a potential weakness in my storytelling. My style is g...
I've been struggling for a while with my CV and I need help on deciding which sections should I include in it? I lack the formatting skill, I remember studying in school how to prepare my CV - ther...
Many word processors are capable to tracking and displaying changes made to a document. Those changes are typically displayed in special markup supported by the editor. E.g. But when using a pla...
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...
So in elementary school, I was told not to use Wikipedia too much because you can't trust what they write. So then for all the projects, I used the Canadian Encyclopedia, but then now, I really wou...
Software developers don't ever work in text editors, instead they use IDEs (integrated development environments) full of code assistance tools, etc. Why don't writers use similarly advanced writin...
My main character is up against the world, or, rather, the world and reality are up against her. A good story is in some ways defined by its villain. 1984 personifies its villain by adding a repr...
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...
In programming, it's usually accepted that DRY code is better code in most situations. Does this principle also apply to documentation? I'm asking about the documentation output, not necessarily ...
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...
Using git to track modifications to the project allows contributors to include comments with each commit. If the project's guidelines, and managers' control, keeps those comments limited to a forma...
Is anyone aware of a plugin for MS Word that allows me to keep my documents in a git repository (gitlab compatibility would be even better)? I'm aware that git diffs won't be very meaningful, merge...
I noted in this question: What is the best way to learn technical writing? ...that a rated method to learn how to write technical documents is to imbibe good examples. Can you recommend any exam...
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]...
Following up on my previous question, "How to make the villain's motives understandable if his logic is flawed?", how can I let the reader know that the lack of logic is on the character's side, in...
I wonder, what could be a good way to provide time measures in a fantasy universe. I don't mean the calendar which is covered in the question: Out of this world... Giving it time?, but measures lik...
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've not done collaborative writing before, but I've read several works, and sometimes the text strikes me as having a split personality: some parts were clearly written by one author, while others...
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 been gathering ideas for a novel. The basic idea is in place; the story combines two different eras but the same place. How do I get the little details about the place, the people, their lif...
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...
In the context of a technical manual, I need to write instructions guiding users through several standard manipulations. When providing examples of these manipulations, I have written a short sente...
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...
This is a question related to my previous question about child's morality, but different criteria are applied. Criteria and Question: My desired kid would be born commoner but from merchant class, ...
I am very bad at writing children characters in my stories, I always make them either too "dumb" or too developed. Currently I am in need of believable child +- 13, boy or girl. Requirements: My de...
In this answer, Mark Baker makes a statement about story: All story ideas are basically a variation on one thing. A man (or woman, or child, or small furry animal) has two desires, both of which h...
