Questions tagged [examples]

Creating, maintaining, and presenting usage examples in documentation.

Filter by
Sorted by
Tagged with
0 votes
0 answers
21 views

how to list questions in parenthetical examples

I am writing a professional document, and want to include three equally-weighted examples at the end of a sentence. Two of the examples are questions. What is the correct way/is there a way to ...
user avatar
  • 1
0 votes
1 answer
77 views

Providing examples for the sake of it

I am writing an academic text about linguistics. I have managed to obtain examples from endangered languages that are rarely included in research (one in particular has less than 500 speakers ...
user avatar
8 votes
3 answers
5k views

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

I'm writing a thesis in English (I'm not a native speaker) and I suddenly wondered: should I use 'for example' or 'e.g.'? should try to completely avoid both? There are no university specific ...
user avatar
3 votes
2 answers
99 views

Putting code examples in BSC thesis

I am writing my bachelor's thesis in software engineering. It is split into two parts: a theoretical part where I analyze existing literature, compare models and draw conclusions; and a part where I ...
user avatar
3 votes
1 answer
80 views

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

Is there one Screenplay that is an example of being perfectly written by the majority of screenwriters that they keep at the ready to refer to while writing their own works? I was hoping to learn of ...
user avatar
9 votes
5 answers
124 views

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

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 ...
user avatar
0 votes
1 answer
40 views

Find error in this sentence [closed]

Do not/ get panicked/ in emergencies/ no error. I think,here 'panicked' is an adj, and hence 'no error' . If it is not so....then please suggest the right ans...
user avatar
2 votes
5 answers
905 views

How to structure a sentence containing long code examples?

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 sentence ...
user avatar
2 votes
3 answers
437 views

Copyright of examples used in books?

I'm getting into non-fiction technical writing (a blog, but potentially ebook or otherwise). Often the best technical advice come from dissecting and synthesising good and bad examples from the ...
user avatar
  • 129
10 votes
2 answers
3k views

Good Examples of and Practices in Code Documentation

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 ...
user avatar
10 votes
6 answers
10k views

Demo data in screenshots! What are the best practice?

My question is related to best practices of making screenshots for end-user documentation. Particularly, is there universal information for filling in forms in the software and after that making ...
user avatar
22 votes
7 answers
3k views

Best practices for maintaining documented code examples?

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 ...
user avatar