Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read
Q&A

Posts tagged examples

This tag doesn't have any usage information yet.

This tag doesn't have a detailed wiki yet.

71%
+3 −0
Q&A 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 l...

4 answers  ·  posted 5y ago by Lefty G Balogh‭  ·  last activity 1y ago by Monica Cellio‭

75%
+4 −0
Q&A 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 exam...

1 answer  ·  posted 8y ago by Stefan Piskorski‭  ·  edited 2y ago by Monica Cellio‭

66%
+2 −0
Q&A How can we format code examples so that they work on a range of devices?

We use Madcap Flare to produce a large documentation set that contains many code examples (primarily SQL, but also C++, Java, and Python) and command-line operations. When the doc set was first pl...

1 answer  ·  posted 2y ago by Monica Cellio‭  ·  last activity 2y ago by manassehkatz‭

66%
+2 −0
Q&A 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 sente...

4 answers  ·  posted 7y ago by Dave Jones‭  ·  edited 2y ago by Monica Cellio‭

60%
+1 −0
Q&A 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 ...

4 answers  ·  posted 10y ago by Monica Cellio‭  ·  edited 2y ago by Monica Cellio‭

50%
+0 −0
Q&A 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 sc...

1 answer  ·  posted 9y ago by Yuliya Drygybka‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A '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 r...

2 answers  ·  posted 4y ago by Cold_Class‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A 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 ...

1 answer  ·  posted 4y ago by David Szalai‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A 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 ind...

2 answers  ·  posted 8y ago by Pie21‭  ·  last activity 3y ago by System‭

This community is part of the Codidact network. We have other communities too — take a look!

You can also join us in chat!

Want to advertise this community? Use our templates!

Like what we're doing? Support us! Donate