Comments on: The Value of (Good) Documentation https://lizards.opensuse.org/2009/01/16/the-value-of-good-documentation/ Blogs and Ramblings of the openSUSE Members Fri, 06 Mar 2020 17:50:09 +0000 hourly 1 By: sushma https://lizards.opensuse.org/2009/01/16/the-value-of-good-documentation/#comment-854 Sat, 21 Mar 2009 11:01:03 +0000 http://lizards.opensuse.org/?p=360#comment-854 But then, examples are something which are redundant @ times.
I am a technical write. and I see that some audience feel that its redundant.
and eventually if there is a need for examples, completely depends on the audience.

]]> By: Josef Reidinger https://lizards.opensuse.org/2009/01/16/the-value-of-good-documentation/#comment-635 Mon, 19 Jan 2009 07:48:56 +0000 http://lizards.opensuse.org/?p=360#comment-635 I absolute agree with this post and also with above comments about examples. I think that this should be mark as “must read” for everyone who want write documentation.

]]> By: Thomas Schraitle https://lizards.opensuse.org/2009/01/16/the-value-of-good-documentation/#comment-629 Sat, 17 Jan 2009 07:20:56 +0000 http://lizards.opensuse.org/?p=360#comment-629 You are definitly right Ciaran. I love examples, they are very important.

]]> By: Ciaran Farrell https://lizards.opensuse.org/2009/01/16/the-value-of-good-documentation/#comment-628 Fri, 16 Jan 2009 21:00:37 +0000 http://lizards.opensuse.org/?p=360#comment-628 What I find lacking in quite a lot of documentation is examples. It’s ok to list out commandline options etc, but it would make it much easier to understand if there were examples for common usage.

For APIs and programming in general, brief examples of how an API etc can be used are really valuable. It can save a lot of hassle and trial/error if an example is provided.

]]>