qgis / QGIS-Documentation

QGIS Documentation
https://docs.qgis.org/latest
474 stars 696 forks source link

Accurate Documentation #9105

Open lauriefitzherbert opened 5 months ago

lauriefitzherbert commented 5 months ago

Having wasted hours trying to "figure out" the Training Manual (Lesson 12.1 on GRASS) and receiving this input: @DelazJ wrote:

Ssorry to say but I'm afraid that most of the issues you face are likely documentation errors, not yours. This chapter (and a few others) hasn't been updated for years but QGIS has evolved, so did GRASS, hence there are a number of outdated instructions there.

I'd like to offer a suggestion.

Where development programming has caused changes to the User Interface affecting the QGIS Training Manual and QGIS Documentation, the "instruction" or "lesson" should be FLAGGED during PreRelease.

Notes from New Release Development might easily be paired by query of potentially affected documentation. Perhaps it could generate FLAGS that might automatically darken or cast highlight over affected instruction sets in a manner OBVIOUS to New Users or in some cases eliminate visibility of a non-working instruction. Only when the instruction has been corrected would the flag be removed.

New Users come to QGIS often testing the software for use on a large project. Once a New User becomes frustrated, not realizing Official Documentation is erroneous, a usual course of action is to unfairly deemed the program unreliable. This leads to non-use of the software on important projects where QGIS would outshine all others. It can also unfairly tarnish reputations. Good documentation is paramount to the continued success of a complex software. Yet, in this case it would almost be better to have no instruction then "official" bad instruction.

gregorywaynepower commented 4 months ago

@lauriefitzherbert Is there any way you can link to the conversation? Per-chance we could update the documentation in question?