5 votes

Copyright of examples used in books?

Speaking as a programmer, the solution to your problem is "don't be lazy." Taking screenshots is easy but risks libeling others: It can include their logo, their product picture, their address and ...
Amadeus's user avatar
  • 101k
4 votes

What are the benefits of including complete working code samples in documentation

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 ...
ForEachLoop's user avatar
4 votes

What are the benefits of including complete working code samples in documentation

I can understand the reasoning from both sides. A complete quick start is essential to ensure that the reader has sufficient information to see the product running correctly, and is able to ...
Jason Fox's user avatar
  • 477
4 votes

What are the benefits of including complete working code samples in documentation

The value of adding code examples to documentation depends on the example itself as well as the API or library in question. I work with a widely used software library, and we have a stated expectation ...
wowsuchnamaste's user avatar
4 votes

'for example' and 'e.g.' in a thesis

"E.g." is an abbreviation for the Latin "exempli gratia", which means "for example". The abbreviation is fairly common in "advanced" writing, like theses, in my experience. However, it's an other-...
Monica Cellio's user avatar
3 votes

'for example' and 'e.g.' in a thesis

They mean exactly the same thing. Outside of cases where you must following a specific manual of style, if the writing is formal, it's up to you. You should, however (according to Strunk), place e.g. ...
De Novo's user avatar
  • 1,238
3 votes

Is there any screenplay which is widely considered by screenwriters to be perfectly written?

Yes, there are many. You can find them quoted in scriptwriting textbooks. For instance, Linda Seger in her famous book Making a good script great cites The witness by E. Wallace and W. Kelley as a ...
FraEnrico's user avatar
  • 3,837
3 votes

What are the benefits of including complete working code samples in documentation

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 ...
Monica Cellio's user avatar
2 votes

What are the benefits of including complete working code samples in documentation

The purpose of API documentation is to explain how to use the API. Providing sample code of how to use key features is a good way to demonstrate the intended usage. A good example of this is the ZMQ ...
sphennings's user avatar
2 votes

Find error in this sentence

Do not get panicked in emergencies. is okay. But whether you want to write it that way is a second point. Why not simply say: Do not panic in emergencies. It says the same, and it's easier to ...
Boondoggle's user avatar
2 votes

Providing examples for the sake of it

Add an Appendix If your examples detract from the flow of the main body, remove them and put them at the end in an appendix with an explanation as to why you feel its important to include in the book.
Allan's user avatar
  • 301
2 votes
Accepted

'for example' and 'e.g.' in a thesis

I can find nothing to indicate that e.g. (or 'for example') should be left out of a thesis, or any other body of writing. If you do, however, want to use a different indicator then 'such as' is a ...
robertcday's user avatar
  • 7,743
2 votes

Copyright of examples used in books?

Even "fair use" doesn't cover the reaction of the owner and won't protect the intent of the user. As my retired attorney father often said, "anyone can sue anybody for anything at any time." If you ...
JBH's user avatar
  • 668
1 vote

Demo data in screenshots! What are the best practice?

You can use Sherlock Holmes, since he is a public domain fictional character and he has a famous fictional address. I think this adds a little fun but not so much that it is distracting, and it feels ...
Simon White's user avatar
  • 1,368

Only top scored, non community-wiki answers of a minimum length are eligible