Search
Automated systems such as Sandcastle and Swagger are good at converting code syntax into documentation. Those will produce marginal documentation. What they don't do is add insight into the calls. ...
I worked on a project that sounds similar to yours in which the ability to identify every process that touched every piece of data was vital in order to minimize the amount of code validation that ...
If you have a few exceptional use cases, they should be indicated as such when they occur. If all other cases relate to a single problem space (user privileges in this example), this should be in...
Qualities of the documentation itself, even quantitive ones, usually have little intrinsic value. However, quantitive impact of docs on other areas can be often precisely measured and meaningfully...
It's simple really. Write about anything that interests you Write something, proof, rewrite repeat. Submit wait, wait, wait, deal with rejection. Start over if you repeat this process while writin...
While honesty is an admirable trait, I feel the prime "purpose" of friends and family is to offer support, not criticism. People who make it in the world usually have close relations who stand by ...
Your best bet is to build from your previous experience working for magazines and journals by submitting to ones that pay. In addition to the big, general interest publications, there are a lot of...
There have been significant changes in technical communication style over the last 20 years, and particularly in the last five years as increasing volumes of evidence have shown that simple friendl...
How should you respond? Take a careful and critical look at your own writing, and - in effect - do as your supervisor has suggested. We all get attached to our own writing, word choice, phrases, a...
I think Dia, which is a general diagram editor, checks most or all of your boxes. http://dia-installer.de/
The diagram in the OP could be written as a tree of text. threat from Venda marriage to prince Jaxon betrayed by mother / father flees to Terravin to live as a barmaid Rafe + Kaden...
A great free tool that might be a better experience than your answer is LibreOffice Draw. It's free, they support iOS, and it's very intuitive to use for simple to complex diagrams. It's basically ...
The next step would be to get a wider audience. Having people on Facebook and YouTube that read your stuff is already pretty good. Many people also have a Blog where they post their stuff. You coul...
My first thought is, if you're struggling with this issue, why not make your character struggle with it too? If she has no family name, then in situations where she needs to be addressed by one, sh...
There are several ways to address this. This is really just a matter of picking whichever custom you like the best. Intentionally keep the mononym. Your character can decide to not take a surna...
There are no new ideas. Everything has been done. Every plot device has been used a thousand times. Whatever you write it will use ideas that other writers have already used many times over. Plag...
Can you? Yes. There is nothing wrong with it, either legally or ethically. What you're doing would come under "artistic license". In fact, Alexandre Dumas' "The Man in the Iron Mask", for instance,...
I would advise against it. In a historical novel, you do not want to "tamper" with history. That is, you do not want to create a character close enough to a historical figure to be able to re-write...
You should write inspired. You should write in response to vision. Great work is work of great vision, work that sees what we ordinarily miss about human life. Tackling your vision may or may not b...
I think this comes down to how you write. I'm what one might call a method writer, so if I'm not feeling the emotions of my characters, I don't know where they are mentally and emotionally, so I ca...
Music is a performance art, it takes place in "real time." Writing does not. So while there is an inevitable trade-off between spontaneity and polish for a musician, the same is not true for a wr...
What K. M. Weiland writes there is complete and utter nonsense. Fear is a signal to avoid danger. Once the danger is past, fear will subside. If you experience lasting fear, that is pathological ...
Neil Gaiman said "Make good art." In the same speech he says: The moment that you feel that just possibly you're walking down the street naked, exposing too much of your heart and your mind an...
I'm not really a writer, but I argue that in writing, or art, or programming, or any other skill, there is play and there is purpose - and which comes natural (and which doesn't) differs from perso...
So, the question is, how reliable is the advice: If the reader doesn't need it, cut it. If the scene doesn't progress the plot, cut it.[emphasis added] I think you are conflating "needed" with...
