4,755 reputation
1835
bio website cellio.livejournal.com
location Pittsburgh PA
age
visits member for 3 years, 3 months
seen 1 hour ago

I'm an elected moderator on Mi Yodeya and The Workplace, and a pro-tempore mod here on Writers. I'm pretty active on the SE network.

Professionally, I'm a technical writer who works with (and often helps design) programming interfaces. I've written programming guides, tutorials, reference applications (runnable examples), reference documentation (for Java, C++, C, SOAP, and REST APIs), and even a little user documentation. I'd love to see more technical-writing questions here on Writers!

A word of warning: if you are interested in the Biblical Hermeneutics site, I urge you to consider these words from a non-Christian who went down that path. They want people to help build their site (which they say is non-religious), but they allow Christian evangelism and presumption, quite a bit of it. Learn from another's mistake. See also: Working with idolaters, infidels, and the impious: can interfaith discourse work?


Feb
24
reviewed Satisfactory tinyURL seen as risky by readers?
Feb
24
reviewed Needs Improvement Does this opening relate to the message?
Feb
24
reviewed Satisfactory Can the term “Glorified delivery” be used to signify giving birth?
Feb
23
comment How to display URLs in a textbook?
Nice find. Thank you for this answer and for linking to the standard.
Feb
23
answered “Where did X go?” vs “where had X gone.”
Feb
23
reviewed Satisfactory Dates and numbers in newspaper articles
Feb
16
comment How can I get a copyright for my e-book?
@babou I said that because I don't want us to be US-centric, actually. I know that in the US there's a place to register for a copyright, but that'll just apply to the US and (maybe?) other Berne Convention countries. If I were in the UK or India or New Zealand I'd have no idea what to do, but it wouldn't involve the US copyright office.
Feb
14
awarded  Constable
Feb
12
comment Using “he/she” instead of “it” for animals
I agree. The ambiguity of the situation (maybe a real bird, maybe not) calls for "it", as the latter would never be a "he". Even if you know it's a bird, "it" isn't wrong for a bird that you don't know anything about -- as opposed to, say, somebody's pet bird, Polly, whom you know to be a "she".
Feb
11
comment Capitalization of personal event names
On the other hand, if an event has central importance to a plot, even if it hasn't been given the name "officially" (whatever that means), it can sometimes be capitalized. For example, in the series of alternate-history books beginning with 1632, the unexplained event that caused the rip in the fabric of space-time is consistently referred to as the "Ring of Fire". In the case of an essay about a book called The Assault, I would look for capitalization patterns in that book and, if it's done there, do it in the essay.
Feb
9
revised Does excessive use of prepositions make writing unclear?
I think this is what you meant
Feb
7
comment Marking a chart that is not based on real data
@PraveshParekh it's worth checking for any guidelines the university has with respect to this. I'm pretty sure I've seen this in university tech reports and the like; I don't have any thesis-specific experience.
Feb
7
comment How to display URLs in a textbook?
Reviewing prior art can be helpful. It may not apply to your situation, but seeing how others have solved a problem might save you time and frustration.
Feb
6
revised Marking a chart that is not based on real data
added link to example
Feb
6
answered Marking a chart that is not based on real data
Feb
6
comment How to display URLs in a textbook?
There might be style guides out there that address this. I assume those would count as "credible sources". (By the way, the bounty language is SE boilerplate; the bounty-giver didn't write those words.) The web has been broadly available for 20 years now; I would hope that there are industry standards (note plural :-) ) for how to deal with this problem.
Feb
6
comment How to reference a figure from text in a technical document
Are you following a particular style guide? If so, which one?
Feb
3
comment How to display URLs in a textbook?
Also, if you drop the "http://", then the first time you need to use "https://" you have a problem -- your URLs are either wrong or inconsistent in appearance. Don't confuse your readers like that.
Feb
3
comment How should I handle repeating parts in a technical description?
Can you say more about how the documentation will be used? You said a sales document but it sounds like you're writing instructions. Will your readers be trying to take actions based on the documentation, or is the purpose to give them information so they can decide whether to buy your product?
Feb
3
comment How should I handle repeating parts in a technical description?
This is how I would approach it as technical documentation, too. I'm not sure how the sales aspect figures in, though. We need to know more about how this will be used.