Questions tagged [examples]

Creating, maintaining, and presenting usage examples in documentation.

Filter by
Sorted by
Tagged with
7
votes
3answers
865 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 ...
3
votes
2answers
90 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 ...
3
votes
1answer
74 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 ...
9
votes
5answers
85 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 ...
0
votes
1answer
36 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...
2
votes
5answers
627 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 ...
2
votes
3answers
406 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 ...
10
votes
2answers
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 ...
10
votes
6answers
7k 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 ...
22
votes
7answers
2k 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 ...