I have been reading and following this sub-forum for about two months now. In that time, I have noticed an apparent tendency to focus documentation nearly exclusively towards the development version. For example:
The viewpoint indicated here is that the only version to consider is the Development version (currently v0.20) and ignores the fact that there exists a large group of Users relying on the Stable version (currently v0.19). This is not the only example, nor do I suggest it to be in anyway malicious. Rather it happens to be the most recent occurrence that appears to show a lack of User awareness.Draft: Remove obsolete tools?
Postby hmk » 17 Jul 2021 03:10
https://wiki.freecadweb.org/Draft_Module#Obsolete_tools
It seems to me all of these tools, except Array, are no longer available in 0.20 and should be removed?
The FreeCAD Documentation website's Main Page acknowledges three specific group of people -- Users, Power Users, and Developers, I will use these terms with the implied definitions provided by the Main Page. Hence new comers are automatically inlcuded among the Users. Finally I would note that these groups are, within any given topic area, linear ray progressive in nature (e.g. a person cannot be a Power User without first having been a User, and once a having progressed from one group to the next, they are not able to retrograde -- i.e. a Power User will never again innately have the limited perspective of a User for that particular topic).
Many Users are not able to make use of Development versions for any of a broad array of reasons. Thus deleting documentation simply because it does not relate to the Development versions is highly detrimental to Users. Such actions have been, and continue to be, understandably perceived by Users as contemptuous of Users, even though such is not the intent. Therefore, I should like to make the following suggestion as a means to resolve this perception while providing for the needs of all -- those using the Stable Version and those using the Development Versions.
According to the official website, v.0.19 is the current Stable Version. Only the current Stable Version should be used to determine deletions, and not the Development Versions.The Development Versions should be used to make additions (new pages) or parenthetical changes (i.e. the change unique to v0.20 is added in parenthesis while the content of the v0.19 information remains unchanged) only. This allows the documentation to remain relevant for both the Stable (current) and Development (future) versions. Again, Users are far more likely to run the Stable version and thus have need of its "complete" documentation.
If something is no longer available in the development versions, the parenthetical statement should read something like, "(deleted / deprecated in Development Version vX.X.x)". If this statement is added to the page title, it makes finding and archiving / deleting such pages relatively simple when version X.X.x officially becomes the stable version. It also provides immediate historical context (especially helpful for archived documentation).
I personally recommend archiving rather than deleting, as an archive is useful for those working with older versions and provides historical perspective and "corporate memory" information useful to Developers, and possibly Power Users, for future advancements. After all, it is a well proven axiom that "Those who ignore the past, are doomed to repeat the past." So having the archives becomes a benefit.
It is important to remember that the purpose of any documentation is to provide others the knowledge they need to make use of both the Stable and Development versions without, or at least with highly minimized, outside assistance. After all, that is why people are encouraged to search the forum before asking a question.
As the future of FreeCAD is entirely dependent upon Users progressing to Power Users and Developers, it is paramount to ensure they have the best and most successful experience possible. This way we actively encourage their growth into contributing Power Users, Developers, and supporters (Translators, Tutors, etc.). As FreeCAD is always asking for more help, failing to encourage and mentor our Users is in fact actively working against our own best interests .