: Re: 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

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 guide. It has example code in a large number of languages to go with each of the of the concepts discussed.

They combat the bloat by displaying links to the example code in every language the library is supported in. Only when a link is clicked on is the code displayed.

Load Full (0)

: This is dependent upon how likely you are to publish a new training manual when the feature leaves beta. If you are regularly updating your training materials, so that any changes to the

@LarsenBagley300

Load Full 0 Comments

: Do too many scenes exhaust the reader? I'm now analyzing the scenes in my manuscript. I broke my manuscript into scenes using the definition that a new scene begins when a person, place,

@LarsenBagley300

Load Full 3 Comments

: Character, plot, and setting conflicts I'm working through the Sanderson youtube classes on writing fantasy and he discusses the idea that conflict can arise between any two (or three) of the

@LarsenBagley300

Load Full 3 Comments

: How to balance respecting diversity and avoiding tokenism at the same time My project has an environmental theme. My characters eat meals, and because of the setting, this includes meat and

: Re: 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

More posts by @LarsenBagley300

: This is dependent upon how likely you are to publish a new training manual when the feature leaves beta. If you are regularly updating your training materials, so that any changes to the

: Do too many scenes exhaust the reader? I'm now analyzing the scenes in my manuscript. I broke my manuscript into scenes using the definition that a new scene begins when a person, place,

: Character, plot, and setting conflicts I'm working through the Sanderson youtube classes on writing fantasy and he discusses the idea that conflict can arise between any two (or three) of the

: How to balance respecting diversity and avoiding tokenism at the same time My project has an environmental theme. My characters eat meals, and because of the setting, this includes meat and

Login to post a comment!

0 Comments

Back to top