Huge thanks to our Platinum Members Endace and LiveAction,
and our Silver Member Veeam, for supporting the Wireshark Foundation and project.

Wireshark-dev: Re: [Wireshark-dev] Wireshark User's Guide comment/suggestion

From: Jaap Keuter <jaap.keuter@xxxxxxxxx>
Date: Mon, 18 Jun 2018 20:31:42 +0200
Hi,

So you’ve noticed that the community consists more of programmers than documentalists. Getting the software right is difficult enough, let alone the various guides. 

That being said, the format of the user and developer guide has been converted from DocBook into AsciiDoc, but somehow the version information got dropped when setting up the new title page. I can’t find if or why this was done, either on purpose of by accident. It would be simple enough to push a change to have it included (again). 

As for the rest of the content, we (the Wireshark Core Developers) depend on the community to send in changes, to improve the documents. E.g., the MATE documentation was recently added to the Users’ Guide because of the excellent graphics provided by a community member.

Thanks,
Jaap


On 14 Jun 2018, at 16:51, R. Martindale <RMartindale@xxxxxxx> wrote:

While reviewing what I presume to be the current Wireshark User’s Guide (https://wireshark.org/docs/wsug_html_chunked/index.html), I was unable to find any mention of the version of Wireshark to which the guide applies.  Some of the screenshots in the guide differ from what I am seeing on my screen when I run Wireshark under Raspbian GNU/Linux ver 9 (stretch).
 
I respectfully suggest that the Forward of the user’s guide (Preface, Section 1) should identify the Wireshark version for which the guide was targeted and from which the various screenshots were captured. 
 
The way in which obsolete content seems to live forever on the internet makes finding useful information all the more difficult when its applicability or effectivity is not cleared stated.  I frequently find tutorials, how-tos, and other information which at first glance seems useful, but which turns out to do more harm than good because it applies to a particular configuration that is not clearly identified and which differs from what I am using.
 
Thanks for your work on Wireshark and for giving this suggestion some consideration.