KiCad

Should documentation flaws be reported as bugs?

Asked by TomCC

Title says it all.

Why I'm asking:

Eeschema documentation for the product branch is outdated, showing icons from old versions, random pictures with text in french, and lacking info for example, about the Alt+Left-click-drag block rotate (Also can't be found from the hotkey menu) or the fact that Ctrl+same is mirroring, not dragging in Library Editor. I understand that the product branch is supposedly not for the uninitiated to use, but given how old the stable release is and how much has been changed/added, it will be hell to harmonise later.

Also, it bears to mention in as many places as possible that tooltips, not only menus, should contain hotkey info.

Question information

Language:
English Edit question
Status:
Answered
For:
KiCad Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Wayne Stambaugh (stambaughw) said : 		#1

I would rather folks step up an fix the documentation issues rather than file bug reports. A lot of the documentation was written by folks who's first language is not English which is an admirable feat. Also, most of the English documentation was written by developers which is a very limited resource for the project so any time we can offload the non-code writing task it's a big plus for the project. So far that has rarely been the case. That being said, we are in the process of converting to an ascii format to generate the final documentation rather than using Open/LibreOffice. Hopefully the decision of the format and the initial repo are not too far in the future. When that happens, it should be easier for anyone to contribute to the documentation.

I agree, the tooltips could be improved.

Revision history for this message
spanner888 (ourstuff888) said : 		#2

I have been looking around trying to work out how to " step up an fix the documentation issues".

Does anyone have any pointers on how to do this? (user doco - not the code/build doco).

Revision history for this message
spanner888 (ourstuff888) said : 		#3

... and of course now I found it here https://github.com/ciampix/kicad-doc

Can you help with this problem?

Provide an answer of your own, or ask TomCC for more information if necessary.

To post a message you must log in.