Search
It depends on your audience. Blessed Geek suggested UML enumeration, but this assumes that the users understand UML. Your question shows that you know technology well enough to know the capabiliti...
If this is user-facing documentation, then make up a data dictionary that describes the tables and columns with supplementary blurbs about the meaning of the data (e.g. the meanings of specific val...
My top recommendation is this: Identify what the story is attempting to do. Different stories are different creatures. "I'm pretty sure I know how this ends!" can be a harsh indictment for a myst...
Some time ago I came across a Beta reading worksheet. One common thing is to go through those (or other) points and tell the writer only the problems that one found using them. But IMO it's importa...
Whether you put the acronym or the name first depends on how everyone refers to it. If it's almost always an acronym, but you have to explain it on first reference, write it as: New drugs to tr...
I don't think there is any one rule that fits every case here. The golden rule, if anything, would be to not overburden the reader, but keep in mind what they can be expected to know up front. Not ...
One alternative is to "postpone and dilute". It is in fact likely that a very small amount of all the infodump is needed to get the scene running. Add the other elements as you go. To think of a p...
In your question you talk about writing "a scietific journal" (to track your progress), but then you talk about publishing in industry journals. Those are not the same thing -- and when you submit...
I wrote all this before I understood that the desired focus was on video games specifically: I don't know a lot about story writing for video games or coding, but I do have experience with colla...
Info dumping is putting in too much information that bogs down the story. How much is too much depends on a lot of factors, including writing style and genre and PoV. Example: As was customar...
Not sure if I can adequately answer this, since I know little about web development. But I'll try to give some ideas. I would use JavaScript to comment inline and SQL to store the comments. Doub...
I'm a research scientist and professor at a university. We tolerate exactly this "rather curious approach" to research, of multiple refinements until we zero in on something interesting. We do expe...
Building a car is a repeatable process. It happens on an assembly line and each step is the same. There are some small, intentional variations in the process to accommodate customization like pai...
In my experience with writing, I've come to see huge dramatic potential in the distance between a character's actions and a character's dialogue. Put some distance between what he says he will do a...
One way is to have the character's plans that were based on that logic to fall apart later. Also, if you show other examples of the character having flawed logic, then the reader is more likely to ...
Yes, you are doing something wrong. Typically the first thing you think of for a story is not where a story should start, because story ideas begin with big dramatic moments, reveals, discoveries,...
There are different types of examples and they serve different purposes. One type is the quick-start example that this answer describes: a complete, but small, runnable example packaged in a form ...
Working samples is an absolute must for all APIs. Period. Reference pages especially need one. Not including them overlooks the fact that API documentation is used by a range of people. It's short ...
The question whether or not you may use ideas, characters, stories, and so on from other works has been addressed multiple times on this site; you will find them if you use the site search. The sh...
Go with אתה. While not natively Israeli, I am currently living in Israel. And from what I know, speaking the language and seeing what goes on here, when you don't know the gender, it's generally d...
You don't have to just say "He ran", your opening sets the stage for where the action takes place and gives us insight into the character. You can state things about the environment, what the chara...
While I couldn't give you statistics on how prevalent it is, certainly it is not especially rare. I can think of a few major, bestselling authors who have done this off the top of me head easily en...
As a writer if you want to share your work with people at large you need to develop a very thick skin. The nature and to a certain extent culture of the internet in particular means that people fe...
There's two levels to consider here - setting/story and character. Story Some post-apocalyptic settings have introduced religious organisations in, either pre-apocalyptic holdouts or new cults (e...
It's difficult to answer this definitively since there's information you've been unable to share thus far. So for more of a general "how to approach answering this for yourself" answer - I tend to...
