Re: Documentation for LibreCAD Developers
Posted by
Shawn.Curry on
May 23, 2019; 6:32pm
URL: https://forum.librecad.org/Documentation-for-LibreCAD-Developers-tp5717390p5717399.html
Gary S wrote
I agree the instructions should be documented somewhere, however I strongly disagree that the User Manual is the right place for them. The User Manual is an end user document, the VS build instructions are for developers.
I strongly disagree with your strong disagreement.
Developers are users too Gary, and they're
just the sort of users who are going to be looking for the "Build from source" instructions. This is doubly true of the audience interested in doing so on Windows. And even if they're not planning to do any development, you're asking them to have:
Gary S wrote
-C++ compiler and related utilities
-Qt development framework
-Boost C++ source library
These folks aren't going to wilt when they see a few additional steps for Visual Studio. Indeed, that's probably the C++ compiler they already have. It's Qt that will be unfamiliar to them.
My point is, why make them hunt down the instructions someplace else? I had to figure it out on my own, I never found the other instructions. They sure would have been nice to have.
The part that burned me up, was that the first time I interacted with you, you were looking for a review of the windows process, which wasn't working.
Well here I am Gary, a professional windows developer for the past 15 years, who just guided 2 more of his coworkers through the process as well. But you don't want to listen to any of my recommendations; it seems like you're more interested in engaging in a "turf" war with me or something.
In regards to your critiques of my "write-up" (if you can even call it that), you were absolutely right. It's like you point out in the manual,
GaryS wrote
Developers are usually bad in making documentation,
Indeed. That's why we have 2 tech writers in the office now. You would have been horrified to read our old help documentation. I absolutely welcome any critique you would offer. Likewise, I also have some more recommendations for the windows process, if you're willing to listen to them.
-Shawn.