Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accurate Documentation #9105

Open
lauriefitzherbert opened this issue May 15, 2024 · 1 comment
Open

Accurate Documentation #9105

lauriefitzherbert opened this issue May 15, 2024 · 1 comment

Comments

@lauriefitzherbert
Copy link

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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants